Network Edge APIs | Equinix Product Documentation

Upload License File

In case you want to bring your own license (BYOL), you can use this API to post a license file before creating a virtual device.

Security

BearerAuth

metroCodestringrequired

Two-letter metro code where the device will be created.

Example:metroCode=SV

deviceTypeCodestring(DeviceTypeCode)required

Device type code (e.g., C8000V).

Enum:"C8000V""C8000V-SDWAN""PA-VM""ASAV""CGUARD""FG-VM""MERAKI-VMX""PRISMA-SDWAN""INFOBLOX""AVIATRIX_EDGE"

Example:deviceTypeCode=C8000V

licenseTypestringrequired

Type of license (e.g., BYOL).

Value:"BYOL"

Example:licenseType=BYOL

projectIdstring

If projectId is different from default projectId, must pass a projectId parameter

Example:projectId=3da0a663-20d9-4b8f-8c5d-d5cf706840c8

Bodymultipart/form-datarequired

filestring, (binary)required

License file

Example:"binary_content"

Payload

{
  "file": "binary_content"
}

OK

Bodyapplication/json

fileIdstring

The unique ID of the uploaded license file.

Example:"329a0bcd-0b2f-4bc5-b875-b506aa4b9730"

Response

{
  "fileId": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730"
}