Licensing

Post License File

POST /ne/v1/devices/licenseFiles
Method POST
URL or End Point /ne/v1/devices/licenseFiles
Headers Authorization, Content-Type
Query Parameter metroCode, deviceTypeCode, licenseType
Form Data file

Posts a license file from your vendors in case you want to BYOL for a new virtual device. For Juniper and Fortinet devices, you must post a license before creating a virtual device. The response includes a fileId that can be used to create a virtual device.

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

Sample curl request:

Copy 
POST "https://api.equinix.com/ne/v1/devices/licenseFiles?metroCode=SV&deviceTypeCode=CSRSDWAN&licenseType=BYOL"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-H "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
-F "file=@C:\Users\sroy\Desktop\Documents-equinix\CSR-FA819DC1-96FE-497A-89B4-FE3C897C981F.cfg"

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
metroCode Yes string SV Metro code. Metro location for which you want to post a license file.
deviceTypeCode Yes string CSRSDWAN Device type code. Find deviceTypeCode by calling Get device types.
licenseType Yes string BYOL BYOL License type.
Form Parameter Name Mandatory Type Example Applicable Values Description
formData Yes file CSR-FA819DC1-96FE-497A-89B4-FE3C897C981F.cfg A license file that your vendor has provided.

Sample response:

Copy 
{
    "fileId": "e0578172-7461-458f-91db-634f865fcaf5"
}

Description of the 200 Okay response payload:

Field Type Example Values Description
fileId string e0578172-7461-458f-91db-634f865fcaf5 File Id. You can use this ID to create a virtual device on the Network Edge platform.

If you get “Access Denied” error, contact your local Equinix Service Desk.

Post License {uuid}

POST /ne/v1/devices/{uuid}/licenseFiles
Method POST
URL or End Point /ne/v1/devices/{uuid}/licenseFiles
Headers Authorization, Content-Type
Path Parameter uuid
Form Data file

Re-posts a license file in case a provisioned device experiences a license registration failure (REGISTRATION_FAILED). For a redundant device, you must upload two license files, one for each device.

You can only re-post a license file for Equinix-configured devices.


To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.


Sample curl request:

Copy 
curl -X
POST "https://api.equinix.com/ne/v1/devices/299ad92a-70ed-4410-91b1-bb99dbb7b9ad/licenseFiles"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-H "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" 
-F "file=@C:\Users\sroy\Desktop\Documents-equinix\licenseFile.lic"

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string ef673cd4-9fc2-4ab4-810e-7274aaf7bc2d Unique ID of a virtual device.
Form Parameter Name Mandatory Type Example Applicable Values Description
formData Yes file sroyt.lic License file.

Sample response:

Copy 
{
    "fileId": "469240e0-7376-49ce-90ea-8d254b69d2bd"
}

The description of the response payload:

Field Type Example Values Description
fileId string 6651aef5-e738-411f-8675-5f6b7b9cd429 File Id.

If you get “Access Denied” error, contact your local Equinix Service Desk.


Update License

PUT /ne/v1/devices/{uuid}/licenseTokens
Method PUT
URL or End Point /ne/v1/devices/{virtualDeviceUuid}/licenseTokens
Headers Authorization, Content-Type
Path Parameter virtualDeviceUuid
Body Parameter token

Updates a license token/code/ID in case your license fails to register (REGISTRATION_FAILED) at the time of device creation. This request primarily addresses Cisco and Palo Alto devices that require a token to bring your own license (BYOL).

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

Curl request:

Copy 
curl -X
PUT "https://api.equinix.com/ne/v1/devices/9a47a75e-164b-4c1c-8678-7b3605d4dd32/licenseTokens"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d "{
"token": "V74191621"
}"

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 9a47a75e-164b-4c1c-8678-7b3605d4dd32 The unique Id of a virtual device

Body parameter:

Body Parameter Name Mandatory Type Example Applicable Values Description
token Yes string V74191621 License token/Code/ID. This field must have 8 alphanumeric characters.

Sample response:

Copy 
202 Accepted

The description of the response payload:

HTTP Status Description
202 Accepted Token/code/ID was accepted.

If you get “Access Denied” error, contact your local Equinix Service Desk.