Edge Compute

Lumen supports the OAuth 2.0 client credentials authorization grant flow for external access by client-side applications. 

Only existing Lumen customers can access Edge Compute APIs. Please contact your account manager to begin the enrollment process, or click here to begin the enrollment process. Upon enrollment you will receive instructions on how to get started. Once your application is approved you can go to Credentials, below.  For example on getting an Access Token, please see Example Body below.

This endpoint provides authentication for the Lumen Edge Platform user. The response includes a valid access token. If your current token is expired, a new one will be created and returned.  As a prerequisite, you will need Lumen Edge Platform and API Marketplace accounts. 

• Post to https://api.lumen.com/oauth/v1/token
• Content Type = "x-www-form-urlencoded"
• In the Body of your Oauth request, have the following 
  • grant_type = client_credentials
• In Authorization, enter your Applications Tokens received during app enrollment
  • Authorization Type = Basic Auth
  • username = <Consumer Key>
  • password = <Consumer Secret>

Example Body:

Example Authorization:

Example Response:

{
    "refresh_token_expires_in": "28799",
    "refresh_token_status": "approved",
    "api_product_list": "[Edge Compute]",
    "api_product_list_json": [
        "Edge Compute"
    ],
    "organization_name": "ext",
    "developer.email": "example.email@company.com",
    "token_type": "Bearer",
    "issued_at": "1620229269962",
    "client_id": "cxARluuF2Mwg7j6zbdifdJDVhJJDLVqT",
    "access_token": "r9fc115e-cba0-49ed-a9c8-e884a0855c2v",
    "refresh_token": "202156ea-7378-4b5e-bc56-e1fbcfc61f1h",
    "application_name": "a9752f64-2703-9dff-b2e1-0e8c1a8f43r0",
    "scope": "",
    "refresh_token_issued_at": "1620229269962",
    "expires_in": "1799",
    "refresh_count": "0",
    "status": "approved"
}

To make subsequent API requests after you have the access token from Ouath request, you will need to gather the API Token from Edge Orchestrator Portal and add that token to Header:

Step 1 - Go to User Settings

Step 2 - Click API Access

Step 3 - Regenerate Token

Step 4 - Copy Access Token.  This Token will last 1 year.  If there is new version of the Edge Orchestration portal, then this token will need to be regenerated

Step 5 - Use Access Token in Header of API Request (morpheusToken Key)

To make subsequent API requests after you have the access token from Ouath request and the Morpheus Token, you will need to place those tokens in the example below.  The example below is using the Get Dashboard API:

Example Authorization with Bearer Token

Example Headers with Morpheus Token

Please go to our Lumen Edge API Documentation page for sample requests.  Please do not use the ID Codes table in the Edge API Documentation page when creating a Network Instance and a Bare Metal Instance.  Please use the ID Code tables you see in this page

Using Edge Compute API, users must create the network instance first and then create the bare metal instance second. 

The steps below take you through the API experience of Creating a Network and Creating a Bare Metal Instance to assign the newly created network to.

1. Use the Create Instance API for Creating Network Instance

Here is JSON Body request example of the Create an Instance for Network

{

    "zoneId": "11",

    "instance": {

        "name": "NetworkInstanceIPBlockV2",

        "site": {

            "id": "122"

        },

        "instanceType": {

            "id": 306,

            "code": "lumen-network-ip-block"

        },

        "layout": {

            "id": "3962"

        },

        "plan": {

            "id": 4858

        }

    },

    "config": {

        "customOptions": {

            "edgeLocation": "DLLATX37LEC",

            "centuryLinkNetworkType": "EDGE_COMPUTE_INTERNET",

            "edgeBandwidth": "100",

            "networkName": "NetworkInstanceIPBlockV2",

            "NetworkSize": "4858"

        }

    }

}

In terms of the Parameters, below are the ID Codes:

Zone ID is the Cloud Instance that you are using.  All users will use 11

Instance Name (and networkName) is name you are assigning to your Network Instance

Site ID is your Group ID.  To get your Group ID, run the Get All Groups API located at http://apidocs.edge.lumen.com/#get-all-groups

The Instance Types:

The Layouts:

The Network Plans (used for Plan ID and NetworkSize parameters)

For the edgeLocation parameter use ID code table located at: http://apidocs.edge.lumen.com/#locations-table

For the edgeBandwidth parameter use ID code table located at: http://apidocs.edge.lumen.com/#network-type-/-bandwidth

For the centuryLinkNetworkType use EDGE_COMPUTE_INTERNET

This Network instance can be used on multiple bare metal instances, as the network block created allows.

IMPORTANT

In the Response of the Network Instance, capture the Network ID that was created.  You will need that ID when you run the Create an Instance for a Bare Metal server. Once a Bare Metal instance is added to a network instance, there currently is not the ability to change the network instance. This functionality will be part of future releases.

2. Use the Create Instance API for Creating Bare Metal Instances

Here is JSON Body request example of the Create an Instance for Bare Metal servers.

{

    "zoneId": "11",

    "instance": {

        "name": "API_Instance_v1",

        "site": {

            "id": "122"

        },

        "instanceType": {

          "code": "lumen-ebm-centos",  

"id": "302"

        },

        "layout": {

            "id": "3960"

        },

   "hostName": "API_Instance_v1",            

        "plan": {

            "id": "1208"

        }

    },

“type”: “lumen-ebm-centos”,

    "config": {

        "createUser": true,

        "isVpcSelectable": true,

        "customOptions": {

            "edgeLocation": "DLLATX37LEC",

            "networkId":"22712",

            "centuryLinkNetworkType": "EDGE_COMPUTE_VPC"

        }

    }

}

In terms of the Parameters, below are the ID Codes:

Zone ID and Cloud is the Cloud Instance that you are using.  All users will use 11

Instance Name is name you are assigning to your Bare Metal Instance

Site ID is your Group ID.  To get your Group ID, run the Get All Groups API located at http://apidocs.edge.lumen.com/#get-all-groups

Instance Types:

Layouts:

Server Plans:

For the edgeLocation parameter use ID code table located at link below. 

NOTE: You must use same location that was used for Network Instance: http://apidocs.edge.lumen.com/#locations-table

The instance name and the hostName above plan are the same name that customer gives

For the centuryLinkNetworkType use EDGE_COMPUTE_VPC

For the networkId use the Network ID that was create in step 1 when creating Network Instance.

To add multiple Bare Metal Server Instances to the same Network Instance you can simply repeat the above steps for Create Instance API for Creating Bare Metal Instances using the same Network ID. This process can be repeated as many times as the IP allocation for the IP block created allows.