Network Edge APIs (1.0)
Download OpenAPI specification:Download
Network Edge (NE) is a platform that allows customers to deploy and run virtual network services and appliances such as routers, load balancers, and firewalls on a generic device instead of additional dedicated hardware, CapEx and colo space. The Network Edge REST APIs allow you to interact with the Equinix Platform to programmatically create a virtual device and add services. Details on specific use cases can be found in the documentation available on the developer portal.
Get Device Types
Returns device types (e.g., routers and firewalls) that can be launched on the NE platform.
query Parameters
deviceTypeCode | string Device type code (e.g., C8000V) |
category | string Category. One of FIREWALL, ROUTER or SD-WAN |
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
Array of objects (VirtualDeviceType) Array of available virtual device types | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
object (PaginationResponseDto) | |||||||||||||||||||||||||
|
Response samples
- 200
- 500
{- "data": [
- {
- "deviceTypeCode": "C8000V",
- "name": "C8000V router",
- "description": "Extend your enterprise network to public and private clouds with the C8000V series.",
- "vendor": "Cisco",
- "category": "ROUTER",
- "maxInterfaceCount": 0,
- "defaultInterfaceCount": 0,
- "clusterMaxInterfaceCount": 0,
- "clusterDefaultInterfaceCount": 0,
- "availableMetros": [
- {
- "metroCode": "DC",
- "metroDescription": "Ashburn",
- "region": "AMER",
- "clusterSupported": false
}
], - "softwarePackages": [
- {
- "name": "Security",
- "packageCode": "SEC",
- "licenseType": "appx",
- "versionDetails": [
- {
- "cause": { },
- "version": "16.09.02",
- "imageName": "csr-16.09.02",
- "versionDate": "2019-01-01",
- "retireDate": "2024:12:12",
- "status": "ACTIVE",
- "stableVersion": true,
- "allowedUpgradableVersions": [
- "16.09.03"
], - "supportedLicenseTypes": [
- "BYOL",
- "Subscription"
]
}
]
}
], - "deviceManagementTypes": {
- "EQUINIX-CONFIGURED": {
- "type": "EQUINIX-CONFIGURED",
- "licenseOptions": {
- "SUB": {
- "type": "string",
- "name": "string",
- "fileUploadSupportedCluster": true,
- "cores": [
- {
- "core": 4,
- "memory": 4,
- "unit": "GB",
- "flavor": "Small",
- "packageCodes": [
- null
], - "supported": true,
- "tier": 2
}
]
}, - "BYOL": {
- "type": "string",
- "name": "string",
- "fileUploadSupportedCluster": true,
- "cores": [
- {
- "core": 4,
- "memory": 4,
- "unit": "GB",
- "flavor": "Small",
- "packageCodes": [
- null
], - "supported": true,
- "tier": 2
}
]
}
}, - "supportedServices": [
- {
- "name": "string",
- "required": true,
- "packageCodes": [
- "STD"
], - "supportedForClustering": true
}
], - "additionalFields": [
- {
- "name": "string",
- "required": true,
- "isSameValueAllowedForPrimaryAndSecondary": true
}
], - "clusteringDetails": {
- "clusteringEnabled": true,
- "maxAllowedNodes": 0
}
}, - "SELF-CONFIGURED": {
- "type": "SELF-CONFIGURED",
- "licenseOptions": {
- "SUB": { },
- "BYOL": { }
}, - "supportedServices": [
- {
- "name": "string",
- "required": true,
- "packageCodes": [
- "STD"
], - "supportedForClustering": true
}
], - "additionalFields": [
- {
- "name": "string",
- "required": true,
- "isSameValueAllowedForPrimaryAndSecondary": true
}
], - "defaultAcls": {
- "dnsServers": [
- "8.8.8.8"
], - "ntpServers": [
- "STD"
]
}, - "clusteringDetails": {
- "clusteringEnabled": true,
- "maxAllowedNodes": 0
}
}
}
}
], - "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}
}
Get Allowed Interfaces
Returns the interface details for a device type with a chosen configuration. You must pass the device type as the path parameter.
path Parameters
deviceType required | string Device type code. PA-VM. |
query Parameters
deviceManagementType required | string Device management type. SELF-CONFIGURED |
mode | string License mode, either Subscription or BYOL. |
cluster | boolean Whether you want a cluster device. |
sdwan | boolean Whether you want an SD-WAN device. |
connectivity | string Type of connectivity you want. INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. PRIVATE devices do not have ACLs or bandwidth. |
core required | integer The desired number of cores. |
memory | integer Desired memory. |
unit | string Unit of memory. GB or MB. |
flavor | string Flavor of device. |
version | string Version. |
softwarePkg | string Software package. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
Array of objects (AllowedInterfaceProfiles) | |||||||
Array
|
Response samples
- 200
- 404
- 500
{- "interfaceProfiles": [
- {
- "count": 10,
- "interfaces": [
- {
- "name": "ethernet1/1",
- "description": "DATA Interface",
- "interfaceId": 2,
- "status": "AVAILABLE"
}
], - "default": true
}
]
}
Get Available Metros
Gets the available list of metros where NE platform is available. Please note that an account must be created for each country where virtual devices are being purchased.
query Parameters
region | string Name of the region for which you want metros (e.g., AMER) |
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
Array of objects (MetroResponse) | |||||||||
Array
| |||||||||
object (PaginationResponseDto) | |||||||||
|
Response samples
- 200
- 500
{- "data": [
- {
- "metroCode": "SV",
- "metroDescription": "Silicon Valley",
- "region": "AMER",
- "clusterSupported": false
}
], - "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}
}
Get Accounts {metro}
Gets accounts by metro. You must have an account in a metro to create a virtual device there. To create an account go to "accountCreateUrl".
path Parameters
metro required | string Metro region for which you want to check your account status |
query Parameters
accountUcmId | string Unique ID of an account |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
accountCreateUrl | string accountCreateUrl | ||||||||||||||
Array of objects (MetroAccountResponse) | |||||||||||||||
Array
| |||||||||||||||
errorMessage | string error Message | ||||||||||||||
errorCode | string error Code |
Response samples
- 200
{- "accountCreateUrl": "string",
- "accounts": [
- {
- "accountName": "nfv1",
- "accountNumber": 2252619,
- "accountUcmId": "92D27009-EA33-4b60-B4FB-D3C4ED589649",
- "accountStatus": "Active",
- "metros": [
- "DA"
], - "creditHold": false,
- "referenceId": ""
}
], - "errorMessage": "string",
- "errorCode": "string"
}
Get Agreement Status.
Call this API to find out the status of your agreement, whether it is valid or not, or to just read the agreement terms.
query Parameters
account_number required | string account_number |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: */*
errorMessage | string |
isValid | string |
terms | string |
termsVersionID | string |
Create an agreement
Call this API to post an agreement. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
agreementAcceptRequest
accountNumber | string |
apttusId | string The version number of the agreement |
Responses
Response Schema: application/json
status | string |
Request samples
- Payload
{- "accountNumber": 456446,
- "apttusId": "c2Z34000002CXRm"
}
Response samples
- 200
{- "status": "string"
}
Get Vendor Terms
Returns a link to a vendor's terms. The term "vendor" refers to the vendor of a virtual device on the Network Edge platform.
query Parameters
vendorPackage required | string vendorPackage |
licenseType required | string licenseType |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: */*
terms | string |
Get the Price
Returns the price of a virtual device and license based on account number and other fields. Please note that the listed price does not include the price of any optional features added to the device, some of which are charged.
query Parameters
accountNumber | integer <int32> Account number |
metro | string Metro |
vendorPackage | string Vendor package |
licenseType | string License type |
softwarePackage | string Software package |
throughput | integer <int32> Throughput |
throughputUnit | string Throughput unit |
termLength | string Term length (in months) |
additionalBandwidth | integer <int32> Additional bandwidth (in Mbps) |
virtualDeviceUuid | string Virtual device unique Id (only required if existing device is being modified) |
deviceManagementType | string The device management type |
core | integer <int32> The number of cores |
secondaryAccountNumber | integer <int32> The secondary account number (for HA) |
secondaryMetro | string Secondary metro (for HA) |
secondaryAdditionalBandwidth | integer <int32> Secondary additional bandwidth (in Mbps for HA) |
accountUcmId | string Account unique ID |
orderingContact | string Reseller customer username |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PriceResponse) | |||||||||||||||
| |||||||||||||||
object (PriceResponse) | |||||||||||||||
| |||||||||||||||
termLength | string |
Response samples
- 200
- 400
- 500
{- "primary": {
- "billingCommencementDate": "string",
- "billingEnabled": true,
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": 200
}
], - "currency": "string"
}, - "secondary": {
- "billingCommencementDate": "string",
- "billingEnabled": true,
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": 200
}
], - "currency": "string"
}, - "termLength": "24"
}
Get Order Summary
Gets the order summary as a printable pdf file. This API helps customers who have to go through a PO process at their end to make a purchase and need a formal quote
query Parameters
accountNumber | integer <int32> Account number |
metro | string Metro |
vendorPackage | string Vendor package |
licenseType | string License type |
softwarePackage | string Software package |
throughput | integer <int32> Throughput |
throughputUnit | string Throughput unit |
termLength | string Term length (in months) |
additionalBandwidth | integer <int32> Additional bandwidth (in Mbps) |
virtualDeviceUuid | string Virtual device unique Id (only required if existing device is being modified) |
deviceManagementType | string The device management type |
core | integer <int32> The number of cores |
secondaryAccountNumber | integer <int32> Secondary account number (in case you have a device pair) |
secondaryMetro | string Secondary metro (in case you have a device pair) |
secondaryAdditionalBandwidth | integer <int32> Secondary additional bandwidth (in Mbps) |
accountUcmId | string Account unique ID |
orderingContact | string Reseller customer username |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 400
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Get Public Keys
Returns the SSH public keys associated with this organization. If you are a reseller, please pass the account number of you customer to get the public keys.
query Parameters
accountUcmId | string This field is for resellers. Please pass the accountUcmId of your customer to get the public keys. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
uuid | string The unique Id of the keyName and keyValue combination |
keyName | string Key name |
keyValue | string Key value |
keyType | string Type of key, whether RSA or DSA |
Response samples
- 200
- 500
[- {
- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "keyName": "myKeyName",
- "keyValue": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname",
- "keyType": "RSA"
}
]
Create Public Key
Creates a public key. If you are a reseller, pass the account number of your customer to create a key-name and key-value pair.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
keyName, keyValue, and keyType
keyName required | string Key name |
keyValue required | string Key value |
keyType | string Key type, whether RSA or DSA. Default is RSA. |
Responses
Request samples
- Payload
{- "keyName": "myKeyName",
- "keyValue": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname",
- "keyType": "RSA"
}
Response samples
- 400
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Get Downtime Notifications
Returns all planned and unplanned downtime notifications related to APIs and infrastructure. Please pass a token in the header.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
notificationType | string Type of notification, whether planned or unplanned. | ||||||||||
startTime | string Start of the downtime. | ||||||||||
endTime | string End of the downtime. | ||||||||||
Array of objects (ImpactedServices) An array of services impacted by the downtime. | |||||||||||
Array
| |||||||||||
additionalMessage | string Any additional messages. |
Response samples
- 200
- 500
{- "notificationType": "unplanned_downtime",
- "startTime": "2019-08-27T17:30:00Z",
- "endTime": "2019-08-27T17:30:00Z",
- "impactedServices": [
- {
- "serviceName": "Device",
- "impact": "Device",
- "serviceStartTime": "2019-08-27T17:30:00Z",
- "serviceEndTime": "2019-08-27T17:30:00Z",
- "errorMessage": "Create device APIs are currently down."
}
], - "additionalMessage": "Network Edge APIs are currently unavailable. Please try again later."
}
Upload File (Post)
Uploads a license or an initialization file. You can use this API to upload your bootstrap file generated from the Aviatrix controller portal. The response includes the unique ID of the uploaded file.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: multipart/form-data
deviceManagementType | string Device management type, whether SELF-CONFIGURED or not |
file required | string <binary> A license or a cloud_init file. For example, for Aviatrix, this is your bootsrap config file generated from the Aviatrix Controller portal. |
licenseType | string Type of license (BYOL-Bring Your Own License) |
metroCode required | string Two-letter metro code. |
deviceTypeCode required | string Device type code, e.g., AVIATRIX_EDGE |
processType required | string Whether you are uploading a license or a cloud_init file. LICENSE or CLOUD_INIT |
Responses
Response Schema: application/json
fileUuid | string |
Response samples
- 200
- 400
- 403
- 500
{- "fileUuid": "string"
}
Post 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.
query Parameters
metroCode required | string metroCode |
deviceTypeCode required | string deviceTypeCode |
licenseType required | string licenseType |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: multipart/form-datarequired
file required | string <binary> file |
Responses
Response Schema: application/json
fileId | string |
Response samples
- 200
- 400
- 403
- 500
{- "fileId": "string"
}
Post License {uuid}
In case you want to bring your own license and have already created a virtual device, use this API to post a license file. You can also use this API to renew a license that is about to expire.
path Parameters
uuid required | string Unique Id of a virtual device |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: multipart/form-datarequired
file required | string <binary> License file |
Responses
Response Schema: application/json
fileId | string |
Response samples
- 200
- 400
- 403
- 500
{- "fileId": "string"
}
Update License Token/ID/Code
If you want to bring your own license (BYOL), you can use this API to post or update a license token after a virtual device is created.
path Parameters
uuid required | string Unique Id of a virtual device |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
License token
token | string |
Responses
Request samples
- Payload
{- "token": "A1025025"
}
Response samples
- 202
- 400
- 404
- 500
{- "fileId": "string"
}
Create Virtual Device
Creates a virtual device. Sub-customers cannot choose the subscription licensing option. To create a device, you must accept the Order Terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.
query Parameters
draft | boolean Default: false draft |
draftUuid | string draftUuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Create a virtual device (e.g., a router or a firewall)
accountNumber | string Account number. Either an account number or accountReferenceId is required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountReferenceId | string AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projectId | string Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version required | string Version. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceTypeCode required | string Virtual device type (device type code) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hostNamePrefix | string Host name prefix for identification. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14 characters; Aruba 2-24 characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
agreeOrderTerms required | boolean To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseMode required | string License type. One of SUB (Subscription) or BYOL (Bring Your Own License) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseCategory | string This field will be deprecated in the future. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseFileId | string For Juniper devices you need to provide a licenseFileId if you want to BYOL (Bring Your Own License). You get a licenseFileId when you upload a license file by calling license upload API (Upload a license file before creating a virtual device). For Cisco devices, you do not need to provide a licenseFileId at the time of device creation. Once the device is provisioned, you can get the deviceSerialNo by calling Get virtual device {uuid} API. With the deviceSerialNo you can generate a license file on Cisco site. Afterward, you can upload the license file by calling license upload API (Upload a license file after creating a virtual device). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseToken | string In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
day0TextFileId | string Some devices require a day0TextFileId. Upload your license file by calling Upload File API. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual device. Check the payloads of individual devices (provided as Postman Scripts on our API doc site) for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termlength | string Term length in months. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metroCode required | string Metro code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageCode | string Software package code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (sshUsers) An array of sshUsernames and passwords | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throughput | integer <int32> Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throughputUnit | string Throughput unit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tier | integer Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
virtualDeviceName required | string Virtual device name for identification. This should be minimum 3 and maximum 50 characters long. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderingContact | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifications required | Array of strings Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ACLDetails) An array of ACLs | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalBandwidth | integer <int32> Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceManagementType required | string Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
core required | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
interfaceCount | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
siteId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
systemIpAddress | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VendorConfig) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserPublicKeyRequest) An object with public key details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipType | string This field is deprecated. The ipType value always defaults to STATIC. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sshInterfaceId | string You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
smartLicenseUrl | string License URL. This field is only relevant for Ciso ASAv devices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
diverseFromDeviceUuid | string Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ClusterConfig) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primaryDeviceUuid | string This field is mandatory if you are using this API to add a secondary device to an existing primary device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectivity | string Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channelPartner | string The name of the channel partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cloudInitFileId | string The Id of a previously uploaded license or cloud_init file. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchaseOrderNumber | string Purchase Order information will be included in your order confirmation email. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderReference | string Enter a short name/number to identify this order on the invoice. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualDevicHARequest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "accountNumber": 10478397,
- "accountReferenceId": 209809,
- "projectId": "XXXX-XXXX-XXXXX-XXXXXXXXXXXXXXXX",
- "version": "16.09.03",
- "deviceTypeCode": "C8000V",
- "hostNamePrefix": "mySR",
- "agreeOrderTerms": true,
- "licenseMode": "SUB",
- "licenseCategory": "flex",
- "licenseFileId": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "day0TextFileId": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "termlength": "string",
- "metroCode": "SV",
- "packageCode": "IPBASE",
- "sshUsers": [
- {
- "sshUsername": "cust0001_DC",
- "sshPassword": "projPass",
- "sshUserUuid": "999a3aa2-c49a-dddd-98a6-007424e73777",
- "action": "CREATE"
}
], - "throughput": 1,
- "throughputUnit": "Gbps",
- "tier": 1,
- "virtualDeviceName": "Router1-c8000v",
- "orderingContact": "subuser01",
- "notifications": [
- "test1@equinix.com",
- "test2@equinix.com"
], - "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
], - "additionalBandwidth": 100,
- "deviceManagementType": "EQUINIX-CONFIGURED",
- "core": 0,
- "interfaceCount": 0,
- "siteId": "12345",
- "systemIpAddress": "192.168.2.5",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "localId": "branch1@example.com",
- "remoteId": "companyController1@example.com",
- "managementType": "FMC",
- "controller1": "54.219.248.29",
- "controller2": "54.177.220.115",
- "serialNumber": 4545454,
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "accountName": "accountName",
- "hostname": "myHostname",
- "accountKey": "Primary Account Key1",
- "applianceTag": "applianceTag",
- "userName": "string",
- "connectToCloudVision": true,
- "cvpType": "As-a-Service",
- "cvpFqdn": "www.NetworkSolutions.com",
- "cvpIpAddress": "192.168.0.10",
- "cvaasPort": 443,
- "cvpPort": 443,
- "cvpToken": 123,
- "provisioningKey": "samppleKey",
- "privateAddress": "192.168.20.32",
- "privateCidrMask": 24,
- "privateGateway": "192.168.20.1",
- "licenseId": 123457777,
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "userPublicKey": {
- "username": "test-user-1",
- "keyName": "test-pk-2"
}, - "ipType": "STATIC",
- "sshInterfaceId": "4",
- "diverseFromDeviceUuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "clusterDetails": {
- "clusterName": "My Cluster",
- "clusterNodeDetails": {
- "node0": {
- "licenseFileId": "string",
- "licenseToken": "string",
- "vendorConfig": {
- "hostname": "myname1",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "adminPassword": "ZQeIDI7sUd",
- "controller1": "54.219.248.29",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}
}, - "node1": {
- "licenseFileId": "string",
- "licenseToken": "string",
- "vendorConfig": {
- "hostname": "myname1",
- "rootPassword": "myPassw0rd!",
- "adminPassword": "ZQeIDI7sUd",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}
}
}
}, - "primaryDeviceUuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "connectivity": "INTERNET-ACCESS",
- "channelPartner": "SDCI",
- "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691",
- "purchaseOrderNumber": 789065,
- "orderReference": "345678A",
- "secondary": {
- "accountNumber": 10478398,
- "accountReferenceId": 209805,
- "version": "16.09.03",
- "additionalBandwidth": 100,
- "licenseFileId": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "day0TextFileId": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "metroCode": "SV",
- "notifications": [
- "test1@example.com"
], - "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
], - "sshUsers": [
- {
- "sshUserUuid": "999a3aa2-c49a-dddd-98a6-007424e73777",
- "action": "CREATE",
- "sshUsername": "cust0001_DC",
- "sshPassword": "projPass"
}
], - "virtualDeviceName": "Router1-c8000v",
- "hostNamePrefix": "mySR",
- "siteId": "12345",
- "systemIpAddress": "192.168.2.5",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "localId": "branch1@example.com",
- "remoteId": "companyController1@example.com",
- "managementType": "FMC",
- "controller1": "54.219.248.29",
- "controller2": "54.177.220.115",
- "serialNumber": 4545454,
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "accountName": "accountName",
- "hostname": "myHostname",
- "accountKey": "Primary Account Key1",
- "applianceTag": "applianceTag",
- "userName": "string",
- "connectToCloudVision": true,
- "cvpType": "As-a-Service",
- "cvpFqdn": "www.NetworkSolutions.com",
- "cvpIpAddress": "192.168.0.10",
- "cvaasPort": 443,
- "cvpPort": 443,
- "cvpToken": 123,
- "provisioningKey": "samppleKey",
- "privateAddress": "192.168.20.32",
- "privateCidrMask": 24,
- "privateGateway": "192.168.20.1",
- "licenseId": 123457777,
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "sshInterfaceId": "4",
- "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691"
}
}
Response samples
- 202
- 400
- 403
- 500
{- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae"
}
Get Virtual Devices
Returns all the available virtual devices, i.e. routers and routers, on the Network Edge platform.
query Parameters
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
metroCode | string metroCode |
status | string status |
showOnlySubCustomerDevices | boolean Resellers may mark this Yes to see sub customer devices. |
accountUcmId | string Unique ID of the account. |
searchText | string Enter text to fetch only matching device names |
sort | Array of strings Sorts the output based on field names. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VirtualDeviceDetailsResponse) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 500
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "accountName": "ABC INC",
- "accountNumber": "133911",
- "createdBy": "cust0001",
- "createdDate": "2018-01-30T10:30:31.387Z",
- "deletedBy": "cust0001",
- "deletedDate": "2018-01-30T10:30:31.387Z",
- "deviceSerialNo": "53791666484",
- "deviceTypeCategory": "ROUTER",
- "diverseFromDeviceName": "My-Other-Device",
- "diverseFromDeviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceTypeCode": "C8000V",
- "deviceTypeName": "C8000v router",
- "expiry": "2019-02-07 00:00:00",
- "region": "AMER",
- "deviceTypeVendor": "Cisco",
- "hostName": "VR-SV-C8000V-cust0001-1",
- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "lastUpdatedBy": "cust0002",
- "lastUpdatedDate": "2018-01-30T10:30:31.387Z",
- "licenseFileId": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "licenseName": "Bring your own license",
- "licenseStatus": "REGISTERED",
- "licenseType": "BYOL",
- "metroCode": "SV",
- "metroName": "Silicon Valley",
- "name": "AWS-Azure-Router-c8000v",
- "notifications": [
- "test@equinix.com"
], - "packageCode": "SEC",
- "packageName": "Security",
- "version": "16.09.02",
- "purchaseOrderNumber": "PO1223",
- "redundancyType": "PRIMARY",
- "redundantUuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa67xx",
- "connectivity": "INTERNET-ACCESS",
- "sshIpAddress": "10.195.11.23",
- "sshIpFqdn": "test-device-168-201-97-149.eis.lab.equinix.com",
- "sshIpFqdnStatus": "ASSIGNED",
- "status": "PROVISIONED",
- "throughput": 500,
- "throughputUnit": "Mbps",
- "core": {
- "core": 4,
- "memory": 4,
- "unit": "GB",
- "tier": 2
}, - "pricingDetails": {
- "termLength": 36,
- "orderNumber": "1-198735018693",
- "core": 4,
- "throughput": 1,
- "ThroughputUnit": "Gbps",
- "packageCode": "AX",
- "additionalBandwidth": 100,
- "primary": {
- "currency": "USD",
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": 200
}
]
}, - "secondary": {
- "currency": "USD",
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": 200
}
]
}
}, - "interfaceCount": 10,
- "deviceManagementType": "EQUINIX-CONFIGURED",
- "plane": "PRIMARY",
- "userPublicKey": {
- "username": "test-user-1",
- "publicKeyName": "test-pk-2",
- "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\\nGPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3\\nPbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA\\nt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88Xypsamplesample"
}, - "managementIp": "10.195.237.228/26",
- "managementGatewayIp": "10.195.237.254",
- "publicIp": "149.97.198.95/31",
- "publicGatewayIp": "149.97.198.94",
- "primaryDnsName": "4.0.0.53",
- "secondaryDnsName": "129.250.35.250",
- "termLength": 12,
- "newTermLength": 24,
- "additionalBandwidth": 200,
- "siteId": "12345",
- "systemIpAddress": "192.168.2.5",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "localId": "branch1@example.com",
- "remoteId": "companyController1@example.com",
- "managementType": "FMC",
- "controller1": "54.219.248.29",
- "controller2": "54.177.220.115",
- "serialNumber": 4545454,
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "accountName": "accountName",
- "hostname": "myHostname",
- "accountKey": "Primary Account Key1",
- "applianceTag": "applianceTag",
- "userName": "string",
- "connectToCloudVision": true,
- "cvpType": "As-a-Service",
- "cvpFqdn": "www.NetworkSolutions.com",
- "cvpIpAddress": "192.168.0.10",
- "cvaasPort": 443,
- "cvpPort": 443,
- "cvpToken": 123,
- "provisioningKey": "samppleKey",
- "privateAddress": "192.168.20.32",
- "privateCidrMask": 24,
- "privateGateway": "192.168.20.1",
- "licenseId": 123457777,
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "interfaces": [
- {
- "id": 1,
- "name": "ethernet1",
- "status": "ASSIGNED",
- "operationStatus": "DOWN",
- "macAddress": "fa16.3e1c.a8d8",
- "ipAddress": "2.2.2.2",
- "assignedType": "Equinix Managed",
- "type": "DATA"
}
], - "asn": 1029,
- "channelPartner": "SDCI"
}
]
}
Get Virtual Device {uuid}
Returns the virtual device details of an existing device on the Network Edge platform. You must provide the unique ID of the existing device as a path parameter.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
accountName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountNumber | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdBy | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdDate | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deletedBy | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deletedDate | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceSerialNo | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceTypeCategory | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
diverseFromDeviceName | string The name of a device that is in a location different from this device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
diverseFromDeviceUuid | string The unique ID of a device that is in a location different from this device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceTypeCode | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceTypeName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expiry | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceTypeVendor | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hostName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uuid | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastUpdatedBy | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastUpdatedDate | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseFileId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseStatus | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseType | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metroCode | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metroName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifications | Array of strings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageCode | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchaseOrderNumber | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redundancyType | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redundantUuid | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectivity | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sshIpAddress | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sshIpFqdn | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sshIpFqdnStatus | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throughput | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throughputUnit | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (CoresDisplayConfig) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PricingSiebelConfig) An object that has the pricing and other details of a Siebel order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
interfaceCount | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceManagementType | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plane | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserPublicKeyConfig) An object with public key details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
managementIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
managementGatewayIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publicIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publicGatewayIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primaryDnsName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
secondaryDnsName | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termLength | string Term length in months. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
newTermLength | string The term length effective upon the expiration of the current term. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalBandwidth | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
siteId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
systemIpAddress | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VendorConfig) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (InterfaceBasicInfoResponse) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asn | number The ASN number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channelPartner | string The name of the channel partner. |
Response samples
- 200
- 404
- 500
{- "accountName": "ABC INC",
- "accountNumber": "133911",
- "createdBy": "cust0001",
- "createdDate": "2018-01-30T10:30:31.387Z",
- "deletedBy": "cust0001",
- "deletedDate": "2018-01-30T10:30:31.387Z",
- "deviceSerialNo": "53791666484",
- "deviceTypeCategory": "ROUTER",
- "diverseFromDeviceName": "My-Other-Device",
- "diverseFromDeviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceTypeCode": "C8000V",
- "deviceTypeName": "C8000v router",
- "expiry": "2019-02-07 00:00:00",
- "region": "AMER",
- "deviceTypeVendor": "Cisco",
- "hostName": "VR-SV-C8000V-cust0001-1",
- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "lastUpdatedBy": "cust0002",
- "lastUpdatedDate": "2018-01-30T10:30:31.387Z",
- "licenseFileId": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "licenseName": "Bring your own license",
- "licenseStatus": "REGISTERED",
- "licenseType": "BYOL",
- "metroCode": "SV",
- "metroName": "Silicon Valley",
- "name": "AWS-Azure-Router-c8000v",
- "notifications": [
- "test@equinix.com"
], - "packageCode": "SEC",
- "packageName": "Security",
- "version": "16.09.02",
- "purchaseOrderNumber": "PO1223",
- "redundancyType": "PRIMARY",
- "redundantUuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa67xx",
- "connectivity": "INTERNET-ACCESS",
- "sshIpAddress": "10.195.11.23",
- "sshIpFqdn": "test-device-168-201-97-149.eis.lab.equinix.com",
- "sshIpFqdnStatus": "ASSIGNED",
- "status": "PROVISIONED",
- "throughput": 500,
- "throughputUnit": "Mbps",
- "core": {
- "core": 4,
- "memory": 4,
- "unit": "GB",
- "tier": 2
}, - "pricingDetails": {
- "termLength": 36,
- "orderNumber": "1-198735018693",
- "core": 4,
- "throughput": 1,
- "ThroughputUnit": "Gbps",
- "packageCode": "AX",
- "additionalBandwidth": 100,
- "primary": {
- "currency": "USD",
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": 200
}
]
}, - "secondary": {
- "currency": "USD",
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": 200
}
]
}
}, - "interfaceCount": 10,
- "deviceManagementType": "EQUINIX-CONFIGURED",
- "plane": "PRIMARY",
- "userPublicKey": {
- "username": "test-user-1",
- "publicKeyName": "test-pk-2",
- "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\\nGPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3\\nPbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA\\nt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88Xypsamplesample"
}, - "managementIp": "10.195.237.228/26",
- "managementGatewayIp": "10.195.237.254",
- "publicIp": "149.97.198.95/31",
- "publicGatewayIp": "149.97.198.94",
- "primaryDnsName": "4.0.0.53",
- "secondaryDnsName": "129.250.35.250",
- "termLength": 12,
- "newTermLength": 24,
- "additionalBandwidth": 200,
- "siteId": "12345",
- "systemIpAddress": "192.168.2.5",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "localId": "branch1@example.com",
- "remoteId": "companyController1@example.com",
- "managementType": "FMC",
- "controller1": "54.219.248.29",
- "controller2": "54.177.220.115",
- "serialNumber": 4545454,
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "accountName": "accountName",
- "hostname": "myHostname",
- "accountKey": "Primary Account Key1",
- "applianceTag": "applianceTag",
- "userName": "string",
- "connectToCloudVision": true,
- "cvpType": "As-a-Service",
- "cvpFqdn": "www.NetworkSolutions.com",
- "cvpIpAddress": "192.168.0.10",
- "cvaasPort": 443,
- "cvpPort": 443,
- "cvpToken": 123,
- "provisioningKey": "samppleKey",
- "privateAddress": "192.168.20.32",
- "privateCidrMask": 24,
- "privateGateway": "192.168.20.1",
- "licenseId": 123457777,
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "interfaces": [
- {
- "id": 1,
- "name": "ethernet1",
- "status": "ASSIGNED",
- "operationStatus": "DOWN",
- "macAddress": "fa16.3e1c.a8d8",
- "ipAddress": "2.2.2.2",
- "assignedType": "Equinix Managed",
- "type": "DATA"
}
], - "asn": 1029,
- "channelPartner": "SDCI"
}
Update Virtual Device
Updates certain fields of a virtual device. You can only update the name, term length, status, and notification list of a virtual device.
path Parameters
uuid required | string The unique Id of the device. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
core | integer Use this field to resize your device. When you call this API for device resizing, you cannot change other fields simultaneously. | ||
notifications | Array of strings | ||
termLength | string Term length in months. | ||
termLengthEffectiveImmediate | boolean By default, this field is true. Set it to false if you want to change the term length at the end of the current term. You cannot downgrade the term length before the end of your current term. | ||
virtualDeviceName | string Virtual device name. This should be a minimum of 3 and a maximum of 50 characters. | ||
clusterName | string Cluster name. This should be a minimum of 3 and a maximum of 50 characters. | ||
status | string Status of the device. Use this field to update the license status of a device. | ||
autoRenewalOptOut | boolean By default, the autoRenewalOptOut field is false. Set it to true if you do not want to automatically renew your terms. Your device will move to a monthly cycle at the expiration of the current terms. | ||
object vendor config properties | |||
|
Responses
Request samples
- Payload
{- "core": 8,
- "notifications": [
- "test1@example.com"
], - "termLength": "1, 12, 24, 36",
- "termLengthEffectiveImmediate": false,
- "virtualDeviceName": "RCiscoSTROY",
- "clusterName": "myCluster0123",
- "status": "PROVISIONED",
- "autoRenewalOptOut": true,
- "vendorConfig": {
- "disablePassword": true
}
}
Response samples
- 400
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Delete Virtual Devices
Delete a virtual device. For some device types (e.g., Palo Alto devices), you also need to provide a deactivation key as a body parameter. For a device pair, the deleteRedundantDevice field must be marked True so we delete both the devices simultaneously.
path Parameters
uuid required | string Unique Id of the virtual device. |
query Parameters
deleteRedundantDevice | boolean Default: false Optional parameter in case you have a secondary device. As both primary and secondary devices are deleted simultaneously, this field must be marked True so we delete both the devices simultaneously. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
deletionInfo
deactivationKey | string If you do not provide a deactivation key for a Palo Alto BYOL device, you must contact your vendor to release the license. | ||
object (SecondaryDeviceDeleteRequest) | |||
|
Responses
Request samples
- Payload
{- "deactivationKey": "8dfbd5ba3610234d9e550032603cc34762af140533e2c1de0111d3451d16eefd",
- "secondary": {
- "deactivationKey": "8dfbd5ba3610234d9e550032603cc34762af140533e2c1de0111d3451d16eefd"
}
}
Response samples
- 403
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Update Device Draft
This API is for updating a virtual device draft
and does not support device update as of now.
path Parameters
uuid required | string Unique Id of a Virtual Device |
query Parameters
draft required | boolean Default: true draft |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Update virtual device details
accountNumber | string Account number. Either an account number or accountReferenceId is required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountReferenceId | string AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projectId | string Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version required | string Version. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceTypeCode required | string Virtual device type (device type code) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hostNamePrefix | string Host name prefix for identification. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14 characters; Aruba 2-24 characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
agreeOrderTerms required | boolean To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseMode required | string License type. One of SUB (Subscription) or BYOL (Bring Your Own License) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseCategory | string This field will be deprecated in the future. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseFileId | string For Juniper devices you need to provide a licenseFileId if you want to BYOL (Bring Your Own License). You get a licenseFileId when you upload a license file by calling license upload API (Upload a license file before creating a virtual device). For Cisco devices, you do not need to provide a licenseFileId at the time of device creation. Once the device is provisioned, you can get the deviceSerialNo by calling Get virtual device {uuid} API. With the deviceSerialNo you can generate a license file on Cisco site. Afterward, you can upload the license file by calling license upload API (Upload a license file after creating a virtual device). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
licenseToken | string In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
day0TextFileId | string Some devices require a day0TextFileId. Upload your license file by calling Upload File API. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual device. Check the payloads of individual devices (provided as Postman Scripts on our API doc site) for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
termlength | string Term length in months. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metroCode required | string Metro code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageCode | string Software package code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (sshUsers) An array of sshUsernames and passwords | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throughput | integer <int32> Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throughputUnit | string Throughput unit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tier | integer Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
virtualDeviceName required | string Virtual device name for identification. This should be minimum 3 and maximum 50 characters long. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderingContact | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifications required | Array of strings Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ACLDetails) An array of ACLs | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalBandwidth | integer <int32> Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceManagementType required | string Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
core required | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
interfaceCount | integer <int32> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
siteId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
systemIpAddress | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VendorConfig) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserPublicKeyRequest) An object with public key details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ipType | string This field is deprecated. The ipType value always defaults to STATIC. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sshInterfaceId | string You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
smartLicenseUrl | string License URL. This field is only relevant for Ciso ASAv devices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
diverseFromDeviceUuid | string Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ClusterConfig) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primaryDeviceUuid | string This field is mandatory if you are using this API to add a secondary device to an existing primary device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
connectivity | string Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channelPartner | string The name of the channel partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cloudInitFileId | string The Id of a previously uploaded license or cloud_init file. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purchaseOrderNumber | string Purchase Order information will be included in your order confirmation email. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderReference | string Enter a short name/number to identify this order on the invoice. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VirtualDevicHARequest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "accountNumber": 10478397,
- "accountReferenceId": 209809,
- "projectId": "XXXX-XXXX-XXXXX-XXXXXXXXXXXXXXXX",
- "version": "16.09.03",
- "deviceTypeCode": "C8000V",
- "hostNamePrefix": "mySR",
- "agreeOrderTerms": true,
- "licenseMode": "SUB",
- "licenseCategory": "flex",
- "licenseFileId": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "day0TextFileId": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "termlength": "string",
- "metroCode": "SV",
- "packageCode": "IPBASE",
- "sshUsers": [
- {
- "sshUsername": "cust0001_DC",
- "sshPassword": "projPass",
- "sshUserUuid": "999a3aa2-c49a-dddd-98a6-007424e73777",
- "action": "CREATE"
}
], - "throughput": 1,
- "throughputUnit": "Gbps",
- "tier": 1,
- "virtualDeviceName": "Router1-c8000v",
- "orderingContact": "subuser01",
- "notifications": [
- "test1@equinix.com",
- "test2@equinix.com"
], - "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
], - "additionalBandwidth": 100,
- "deviceManagementType": "EQUINIX-CONFIGURED",
- "core": 0,
- "interfaceCount": 0,
- "siteId": "12345",
- "systemIpAddress": "192.168.2.5",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "localId": "branch1@example.com",
- "remoteId": "companyController1@example.com",
- "managementType": "FMC",
- "controller1": "54.219.248.29",
- "controller2": "54.177.220.115",
- "serialNumber": 4545454,
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "accountName": "accountName",
- "hostname": "myHostname",
- "accountKey": "Primary Account Key1",
- "applianceTag": "applianceTag",
- "userName": "string",
- "connectToCloudVision": true,
- "cvpType": "As-a-Service",
- "cvpFqdn": "www.NetworkSolutions.com",
- "cvpIpAddress": "192.168.0.10",
- "cvaasPort": 443,
- "cvpPort": 443,
- "cvpToken": 123,
- "provisioningKey": "samppleKey",
- "privateAddress": "192.168.20.32",
- "privateCidrMask": 24,
- "privateGateway": "192.168.20.1",
- "licenseId": 123457777,
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "userPublicKey": {
- "username": "test-user-1",
- "keyName": "test-pk-2"
}, - "ipType": "STATIC",
- "sshInterfaceId": "4",
- "diverseFromDeviceUuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "clusterDetails": {
- "clusterName": "My Cluster",
- "clusterNodeDetails": {
- "node0": {
- "licenseFileId": "string",
- "licenseToken": "string",
- "vendorConfig": {
- "hostname": "myname1",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "adminPassword": "ZQeIDI7sUd",
- "controller1": "54.219.248.29",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}
}, - "node1": {
- "licenseFileId": "string",
- "licenseToken": "string",
- "vendorConfig": {
- "hostname": "myname1",
- "rootPassword": "myPassw0rd!",
- "adminPassword": "ZQeIDI7sUd",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}
}
}
}, - "primaryDeviceUuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "connectivity": "INTERNET-ACCESS",
- "channelPartner": "SDCI",
- "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691",
- "purchaseOrderNumber": 789065,
- "orderReference": "345678A",
- "secondary": {
- "accountNumber": 10478398,
- "accountReferenceId": 209805,
- "version": "16.09.03",
- "additionalBandwidth": 100,
- "licenseFileId": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "day0TextFileId": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "metroCode": "SV",
- "notifications": [
- "test1@example.com"
], - "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
], - "sshUsers": [
- {
- "sshUserUuid": "999a3aa2-c49a-dddd-98a6-007424e73777",
- "action": "CREATE",
- "sshUsername": "cust0001_DC",
- "sshPassword": "projPass"
}
], - "virtualDeviceName": "Router1-c8000v",
- "hostNamePrefix": "mySR",
- "siteId": "12345",
- "systemIpAddress": "192.168.2.5",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "localId": "branch1@example.com",
- "remoteId": "companyController1@example.com",
- "managementType": "FMC",
- "controller1": "54.219.248.29",
- "controller2": "54.177.220.115",
- "serialNumber": 4545454,
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "controllerFqdn": "demo.velocloud.net",
- "rootPassword": "myPassw0rd!",
- "accountName": "accountName",
- "hostname": "myHostname",
- "accountKey": "Primary Account Key1",
- "applianceTag": "applianceTag",
- "userName": "string",
- "connectToCloudVision": true,
- "cvpType": "As-a-Service",
- "cvpFqdn": "www.NetworkSolutions.com",
- "cvpIpAddress": "192.168.0.10",
- "cvaasPort": 443,
- "cvpPort": 443,
- "cvpToken": 123,
- "provisioningKey": "samppleKey",
- "privateAddress": "192.168.20.32",
- "privateCidrMask": 24,
- "privateGateway": "192.168.20.1",
- "licenseId": 123457777,
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "sshInterfaceId": "4",
- "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691"
}
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Device Reload History
Returns the reload history of a device. Please send the unique Id of the device as a path parameter.
path Parameters
virtualDeviceUUID required | string Unique ID of a virtual device. |
query Parameters
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||
| |||||||||||
Array of objects (DeviceRebootResponse) | |||||||||||
Array
|
Response samples
- 200
- 500
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "deviceUUID": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "status": "SUCCESS",
- "requestedBy": "nfvsit01",
- "requestedDate": "2020/10/03T19:41:17.976Z",
- "completiondDate": "2020/10/03T19:41:17.976Z"
}
]
}
Trigger Soft Reboot
Triggers the soft reboot of a device. Please send the unique Id of the device as a path parameter.
path Parameters
virtualDeviceUUID required | string Unique ID of a virtual device. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Update Additional Bandwidth
You can use this method to change or add additional bandwidth to a virtual device.
path Parameters
uuid required | string The unique Id of a virtual device |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Additional Bandwidth
additionalBandwidth | integer |
Responses
Request samples
- Payload
{- "additionalBandwidth": 100
}
Response samples
- 400
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Get Device Interfaces
Returns the status of the interfaces of a device. You must pass the unique Id of the device as a path parameter.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
id | number |
name | string |
status | string |
operationStatus | string |
macAddress | string |
ipAddress | string |
assignedType | string |
type | string The type of interface. |
Response samples
- 200
- 404
- 500
[- {
- "id": 1,
- "name": "ethernet1",
- "status": "ASSIGNED",
- "operationStatus": "DOWN",
- "macAddress": "fa16.3e1c.a8d8",
- "ipAddress": "2.2.2.2",
- "assignedType": "Equinix Managed",
- "type": "DATA"
}
]
Ping Virtual Device
Pings a virtual device to ensure it's reachable. At this point, you can only ping a few SELF-CONFIGURED devices.
path Parameters
uuid required | string Virtual Device unique Id |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 400
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Get Interface Statistics
Returns the throughput statistics of a device interface. Pass the unique Id of the device and the interface Id as path parameters.
path Parameters
virtualDeviceUuid required | string Unique Id of a device |
interfaceId required | string Interface Id |
query Parameters
startDateTime required | string Start time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ) |
endDateTime required | string End time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ) |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (InterfaceStatsDetailObject) | |||||||||||||||||||||||||||||||
|
Response samples
- 200
- 404
- 500
{- "stats": {
- "startDateTime": "2023-11-10T19:06:06Z",
- "endDateTime": "2023-11-17T19:06:06Z",
- "unit": "Mbps",
- "inbound": {
- "max": 29.90603462474768,
- "mean": 6.341387726453309,
- "lastPolled": 4.2551751570268115,
- "metrics": [
- {
- "intervalDateTime": "2023-11-10T19:32:14Z",
- "mean": 9.549439345514042
}
]
}, - "outbound": {
- "max": 29.90603462474768,
- "mean": 6.341387726453309,
- "lastPolled": 4.2551751570268115,
- "metrics": [
- {
- "intervalDateTime": "2023-11-10T19:32:14Z",
- "mean": 9.549439345514042
}
]
}
}
}
Get Device Upgrade History
Returns the upgrade history of a device. Please send the unique Id of the device as a path parameter.
path Parameters
virtualDeviceUuid required | string Unique ID of a virtual device. |
query Parameters
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||||
| |||||||||||||
Array of objects (DeviceUpgradeDetailsResponse) | |||||||||||||
Array
|
Response samples
- 200
- 500
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "virtualDeviceUuid": "8ed6ffcb-cef5-4801-83a3-2aa2b6c682f0",
- "status": "SUCCESS",
- "requestedDate": "2020/10/03T19:41:17.976Z",
- "completiondDate": "2020/10/03T19:41:17.976Z",
- "requestedBy": "eqxnfvuser1"
}
]
}
Create ACL Template
Creates ACL templates. You can find the unique ID of the ACL template in the location header.
query Parameters
accountUcmId | string A reseller creating an ACL template for a customer can pass the accountUcmId of the customer. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Creates an ACL template.
name required | string The ACL template name. | ||||||||||||
description required | string The ACL template description. | ||||||||||||
projectId | string Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one. | ||||||||||||
required | Array of objects (InboundRules) An array of inbound rules. | ||||||||||||
Array
|
Responses
Response Schema: application/json
uuid | string |
Request samples
- Payload
{- "name": "Test Template",
- "description": "Test Template Description",
- "projectId": "XXXXX-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXXX",
- "inboundRules": [
- {
- "protocol": "TCP",
- "srcPort": 53,
- "dstPort": "any",
- "subnet": "192.168.1.1/32",
- "seqNo": 1,
- "description": "My Rule 1"
}
]
}
Response samples
- 201
- 400
- 404
- 500
{- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae"
}
Get ACL Templates
Returns all ACL templates. The ACL templates list the networks that require access to the device.
query Parameters
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
accountUcmId | string Unique ID of the account. A reseller querying for the ACLs of a customer should input the accountUcmId of the customer. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||||
| |||||||||||||
Array of objects (DeviceACLTemplatesResponse) | |||||||||||||
Array
|
Response samples
- 200
- 500
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "name": "New template",
- "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "description": "My description",
- "inboundRules": [
- {
- "protocol": "TCP",
- "srcPort": 53,
- "dstPort": "any",
- "subnet": "192.168.1.1/32",
- "seqNo": 1,
- "description": "My Rule 1"
}
], - "createdBy": "nfvsit01",
- "createdDate": "2020/10/03T19:41:17.976Z"
}
]
}
Get ACL Template {uuid}
Returns details of any existing template. You must provide the unique ID of an existing template as a path parameter.
path Parameters
uuid required | string Unique Id of an ACL template |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
name | string The name of the ACL template. | ||||||||||||
uuid | string The unique Id of the ACL template. | ||||||||||||
description | string The description of the ACL template. | ||||||||||||
Array of objects (InboundRules) An array of inbound rules | |||||||||||||
Array
| |||||||||||||
Array of objects (VirtualDeviceACLDetails) The array of devices associated with this ACL template | |||||||||||||
Array
| |||||||||||||
createdBy | string Created by | ||||||||||||
createdDate | string Created date |
Response samples
- 200
- 404
- 500
{- "name": "New template",
- "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "description": "My description",
- "inboundRules": [
- {
- "protocol": "TCP",
- "srcPort": 53,
- "dstPort": "any",
- "subnet": "192.168.1.1/32",
- "seqNo": 1,
- "description": "My Rule 1"
}
], - "virtualDeviceDetails": [
- {
- "name": "Test Device",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab",
- "interfaceType": "WAN",
- "aclStatus": "PROVISIONING"
}
], - "createdBy": "nfvsit01",
- "createdDate": "2020/10/03T19:41:17.976Z"
}
Delete ACL template
Deletes an ACL template. You must provide the unique Id of the ACL template as a path parameter.
path Parameters
uuid required | string Unique ID of an ACL template |
query Parameters
accountUcmId | string A reseller deleting an ACL template for a customer must pass the accountUcmId of the customer. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 403
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Update ACL Template
Updates an ACL template. You must pass the unique Id of the ACL template as a path parameter.
path Parameters
uuid required | string Unique ID of an ACL template |
query Parameters
accountUcmId | string A reseller updating an ACL template for a customer must pass the accountUcmId of the customer. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Update an ACL template.
name required | string The ACL template name. | ||||||||||||
description required | string The ACL template description. | ||||||||||||
projectId | string Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one. | ||||||||||||
required | Array of objects (InboundRules) An array of inbound rules. | ||||||||||||
Array
|
Responses
Request samples
- Payload
{- "name": "Test Template",
- "description": "Test Template Description",
- "projectId": "XXXXX-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXXX",
- "inboundRules": [
- {
- "protocol": "TCP",
- "srcPort": 53,
- "dstPort": "any",
- "subnet": "192.168.1.1/32",
- "seqNo": 1,
- "description": "My Rule 1"
}
]
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Get ACL of Virtual Device
Returns the details of ACL templates associated with a device. You must provide the unique ID of an existing virtual device as a path parameter.
path Parameters
virtualDeviceUuid required | string Unique Id of a virtual device. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (DeviceACLDetailsResponse) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (DeviceACLDetailsResponse) | |||||||||||||||||||||||||||||
|
Response samples
- 200
- 404
- 500
{- "aclTemplate": {
- "name": "New template",
- "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "description": "My description",
- "inboundRules": [
- {
- "protocol": "TCP",
- "srcPort": 53,
- "dstPort": "any",
- "subnet": "192.168.1.1/32",
- "seqNo": 1,
- "description": "My Rule 1"
}
], - "createdBy": "nfvsit01",
- "createdDate": "2020/10/03T19:41:17.976Z",
- "status": "DEVICE_NOT_READY"
}, - "mgmtAclTemplate": {
- "name": "New template",
- "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "description": "My description",
- "inboundRules": [
- {
- "protocol": "TCP",
- "srcPort": 53,
- "dstPort": "any",
- "subnet": "192.168.1.1/32",
- "seqNo": 1,
- "description": "My Rule 1"
}
], - "createdBy": "nfvsit01",
- "createdDate": "2020/10/03T19:41:17.976Z",
- "status": "DEVICE_NOT_READY"
}
}
Add ACL to Virtual Device
Updates the details of ACL templates associated with a device. You must provide the unique ID of an existing virtual device as a path parameter.
path Parameters
virtualDeviceUuid required | string Unique Id of a virtual device. |
query Parameters
accountUcmId | string A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Update the ACL of a device.
required | Array of objects (ACLDetails) An array of ACLs. | ||||
Array
|
Responses
Request samples
- Payload
{- "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
]
}
Response samples
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Update ACL of Virtual Device
Updates or removes the details of ACL templates associated with a device. You must provide the unique ID of an existing virtual device as a path parameter.
path Parameters
virtualDeviceUuid required | string Unique Id of a virtual device. |
query Parameters
accountUcmId | string A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Update the ACL of a device.
required | Array of objects (ACLDetails) An array of ACLs. | ||||
Array
|
Responses
Request samples
- Payload
{- "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
]
}
Response samples
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string"
}
Create Device Link
Call this API to create a device link between virtual devices. You can include any devices that are registered and provisioned.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
New Device Link Group
groupName required | string Group name. | ||||||||
subnet required | string Subnet of the link group. | ||||||||
redundancyType | string Whether the connection should be created through Fabric's primary or secondary port. | ||||||||
Array of objects (LinkDeviceInfo) An array of devices to link. | |||||||||
Array
| |||||||||
Array of objects (LinkInfo) An array of links. | |||||||||
Array
|
Responses
Request samples
- Payload
{- "groupName": "linkGroup",
- "subnet": "192.164.0.0/29",
- "redundancyType": "SECONDARY",
- "linkDevices": [
- {
- "deviceUuid": "9ea5a0e4-2bf7-45c2-9aa7-e846a8cd5560",
- "asn": 1007,
- "interfaceId": 7
}, - {
- "deviceUuid": "8ea5a0e4-2bf7-45c2-9aa7-e846a8cd5561",
- "asn": 2006,
- "interfaceId": 6
}
], - "metroLinks": [
- {
- "accountNumber": 345678,
- "throughput": "1000",
- "throughputUnit": "Mbps",
- "metroCode": "SY"
}
]
}
Response samples
- 202
- 400
- 403
- 500
{- "uuid": "a5d9182d-c529-451d-b137-3742d5a742ce"
}
Get Device Links.
This method returns device links. You can link any two or more devices that are registered and provisioned.
query Parameters
metro | string Metro Code |
virtualDeviceUuid | string Unique Id of a virtual device. |
accountUcmId | string Unique Id of the account. A reseller querying for a customer's link groups can pass the accountUcmId of the customer's account. To get the accountUcmId of your customer's account, please check the Equinix account creation portal (ECP) or call Get account API. |
groupUuid | string Unique Id of a link group |
groupName | string The name of a link group |
offset | string Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (DeviceLinkGroupDto) | |||||||||||||||||||||||
Array
|
Response samples
- 200
- 500
[- {
- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567",
- "groupName": "my-new-link",
- "subnet": "10.0.0.0/27",
- "redundancyType": "SECONDARY",
- "status": "PROVISIONING",
- "createdBy": "nfv-sit1",
- "createdDate": "2019-09-15T10:30:31.387Z",
- "lastUpdatedBy": "reg2-acc1",
- "lastUpdatedDate": "2019-09-16T10:30:31.387Z",
- "metroLinks": [
- {
- "accountName": "Equinix",
- "metroCode": "SY",
- "metroName": "Singapore",
- "throughput": "1000",
- "throughputUnit": "Mbps"
}
], - "linkDevices": [
- {
- "deviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceName": "Cisco Router1",
- "metroCode": "DA",
- "metroName": "Dallas",
- "deviceTypeCode": "C8000V",
- "category": "ROUTER",
- "ipAssigned": "10.0.0.0/27",
- "interfaceId": 5,
- "status": "PROVISIONING",
- "deviceManagementType": "SELF-CONFIGURED",
- "networkScope": "TENANT",
- "isDeviceAccessible": true
}, - {
- "deviceUuid": "5cfb5675-5c3f-4275-adba-0c9e3c26c96c",
- "deviceName": "Cisco Router2",
- "metroCode": "DA",
- "metroName": "Dallas",
- "deviceTypeCode": "C8000V",
- "category": "ROUTER",
- "ipAssigned": "10.0.0.0/27",
- "interfaceId": 5,
- "status": "PROVISIONING",
- "deviceManagementType": "SELF-CONFIGURED",
- "networkScope": "TENANT",
- "isDeviceAccessible": true
}
]
}
]
}
]
Get Device Link {uuid}
This API will return a device link by its unique Id. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string Unique Id of a device link group. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
uuid | string Unique Id of the linked group. | ||||||||||||||||||||||||
groupName | string The name of the linked group | ||||||||||||||||||||||||
subnet | string Subnet of the link group. | ||||||||||||||||||||||||
redundancyType | string Whether the connection is through Fabric's primary or secondary port. | ||||||||||||||||||||||||
status | string Status of the linked group | ||||||||||||||||||||||||
createdBy | string Created by username. | ||||||||||||||||||||||||
createdDate | string Created date. | ||||||||||||||||||||||||
lastUpdatedBy | string | ||||||||||||||||||||||||
lastUpdatedDate | string | ||||||||||||||||||||||||
Array of objects (LinkInfoResponse) An array of links | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
Array of objects (LinkDeviceResponse) An array of metros and the devices in the metros belonging to the group. | |||||||||||||||||||||||||
Array
|
Response samples
- 200
- 404
- 500
{- "uuid": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567",
- "groupName": "my-new-link",
- "subnet": "10.0.0.0/27",
- "redundancyType": "SECONDARY",
- "status": "PROVISIONING",
- "createdBy": "nfv-sit1",
- "createdDate": "2019-09-15T10:30:31.387Z",
- "lastUpdatedBy": "reg2-acc1",
- "lastUpdatedDate": "2019-09-16T10:30:31.387Z",
- "metroLinks": [
- {
- "accountName": "Equinix",
- "metroCode": "SY",
- "metroName": "Singapore",
- "throughput": "1000",
- "throughputUnit": "Mbps"
}
], - "linkDevices": [
- {
- "deviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceName": "Cisco Router1",
- "metroCode": "DA",
- "metroName": "Dallas",
- "deviceTypeCode": "C8000V",
- "category": "ROUTER",
- "ipAssigned": "10.0.0.0/27",
- "interfaceId": 5,
- "status": "PROVISIONING",
- "deviceManagementType": "SELF-CONFIGURED",
- "networkScope": "TENANT",
- "isDeviceAccessible": true
}, - {
- "deviceUuid": "5cfb5675-5c3f-4275-adba-0c9e3c26c96c",
- "deviceName": "Cisco Router2",
- "metroCode": "DA",
- "metroName": "Dallas",
- "deviceTypeCode": "C8000V",
- "category": "ROUTER",
- "ipAssigned": "10.0.0.0/27",
- "interfaceId": 5,
- "status": "PROVISIONING",
- "deviceManagementType": "SELF-CONFIGURED",
- "networkScope": "TENANT",
- "isDeviceAccessible": true
}
]
}
Update Device Link
Call this API to update a device link. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string Unique Id of a device link group. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Device Link Group
groupName required | string Group name. | ||||||||
subnet required | string Subnet of the link group. | ||||||||
redundancyType | string Whether the connection should be created through Fabric's primary or secondary port. | ||||||||
Array of objects (LinkDeviceInfo) An array of devices to link. | |||||||||
Array
| |||||||||
Array of objects (LinkInfo) An array of links. | |||||||||
Array
|
Responses
Request samples
- Payload
{- "groupName": "linkGroup",
- "subnet": "192.164.0.0/29",
- "redundancyType": "SECONDARY",
- "linkDevices": [
- {
- "deviceUuid": "9ea5a0e4-2bf7-45c2-9aa7-e846a8cd5560",
- "asn": 1007,
- "interfaceId": 7
}, - {
- "deviceUuid": "8ea5a0e4-2bf7-45c2-9aa7-e846a8cd5561",
- "asn": 2006,
- "interfaceId": 6
}
], - "metroLinks": [
- {
- "accountNumber": 345678,
- "throughput": "1000",
- "throughputUnit": "Mbps",
- "metroCode": "SY"
}
]
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Delete Device Link
This method deletes a device link group. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string Unique Id of a device link group. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Create BGP Peering
Creates a BGP session to establish a point-to-point connection between your virtual device and cloud service provider. To create BGP peers, you must have a virtual device that is provisioned and registered and a provisioned connection.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
BGP configuration details
authenticationKey | string Provide a key value that you can use later to authenticate. |
connectionUuid | string The unique Id of a connection between the virtual device and the cloud service provider |
localAsn | integer <int64> Local ASN (autonomous system network). This is the ASN of the virtual device. |
localIpAddress | string Local IP Address. This is the IP address of the virtual device in CIDR format. |
remoteAsn | integer <int64> Remote ASN (autonomous system network). This is the ASN of the cloud service provider. |
remoteIpAddress | string Remote IP Address. This is the IP address of the cloud service provider. |
Responses
Request samples
- Payload
{- "authenticationKey": "pass123",
- "connectionUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "localAsn": 10012,
- "localIpAddress": "100.210.1.221/30",
- "remoteAsn": 10013,
- "remoteIpAddress": "100.210.1.31"
}
Response samples
- 202
- 400
- 404
- 500
{- "uuid": "string"
}
Get BGP Peering
Returns BGP configurations on the Network Edge platform. Authorization checks are performed on the users of this API.
query Parameters
virtualDeviceUuid | string Unique Id of a virtual device |
connectionUuid | string Unique Id of a connection |
status | string Provisioning status of BGP Peering |
accountUcmId | string Unique Id of an account. A reseller querying for a customer's devices can input the accountUcmId of the customer's account. |
offset | string Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
authenticationKey | string |
connectionUuid | string |
createdBy | string |
createdByEmail | string |
createdByFullName | string |
createdDate | string |
deletedBy | string |
deletedByEmail | string |
deletedByFullName | string |
deletedDate | string |
lastUpdatedBy | string |
lastUpdatedByEmail | string |
lastUpdatedByFullName | string |
lastUpdatedDate | string |
localAsn | integer <int64> |
localIpAddress | string |
provisioningStatus | string |
remoteAsn | integer <int64> |
remoteIpAddress | string |
state | string |
uuid | string |
virtualDeviceUuid | string |
Response samples
- 200
- 404
- 500
{- "authenticationKey": "string",
- "connectionUuid": "string",
- "createdBy": "string",
- "createdByEmail": "string",
- "createdByFullName": "string",
- "createdDate": "string",
- "deletedBy": "string",
- "deletedByEmail": "string",
- "deletedByFullName": "string",
- "deletedDate": "string",
- "lastUpdatedBy": "string",
- "lastUpdatedByEmail": "string",
- "lastUpdatedByFullName": "string",
- "lastUpdatedDate": "string",
- "localAsn": 0,
- "localIpAddress": "string",
- "provisioningStatus": "string",
- "remoteAsn": 0,
- "remoteIpAddress": "string",
- "state": "string",
- "uuid": "string",
- "virtualDeviceUuid": "string"
}
Update BGP Peering
Updates an existing BGP peering configuration identified by its unique Id. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
BGP config
authenticationKey | string Authentication Key |
localAsn | integer <int64> Local ASN |
localIpAddress | string Local IP Address with subnet |
remoteAsn | integer <int64> Remote ASN |
remoteIpAddress | string Remote IP Address |
Responses
Request samples
- Payload
{- "authenticationKey": "pass123",
- "localAsn": 10012,
- "localIpAddress": "100.210.1.221/30",
- "remoteAsn": 10013,
- "remoteIpAddress": "100.210.1.31"
}
Response samples
- 202
- 400
- 404
- 500
{- "uuid": "string"
}
Get BGP Peering {uuid}
Gets a BGP peering configuration by its unique Id. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
authenticationKey | string |
connectionUuid | string |
createdBy | string |
createdByEmail | string |
createdByFullName | string |
createdDate | string |
deletedBy | string |
deletedByEmail | string |
deletedByFullName | string |
deletedDate | string |
lastUpdatedBy | string |
lastUpdatedByEmail | string |
lastUpdatedByFullName | string |
lastUpdatedDate | string |
localAsn | integer <int64> |
localIpAddress | string |
provisioningStatus | string |
remoteAsn | integer <int64> |
remoteIpAddress | string |
state | string |
uuid | string |
virtualDeviceUuid | string |
Response samples
- 200
- 404
- 500
{- "authenticationKey": "string",
- "connectionUuid": "string",
- "createdBy": "string",
- "createdByEmail": "string",
- "createdByFullName": "string",
- "createdDate": "string",
- "deletedBy": "string",
- "deletedByEmail": "string",
- "deletedByFullName": "string",
- "deletedDate": "string",
- "lastUpdatedBy": "string",
- "lastUpdatedByEmail": "string",
- "lastUpdatedByFullName": "string",
- "lastUpdatedDate": "string",
- "localAsn": 0,
- "localIpAddress": "string",
- "provisioningStatus": "string",
- "remoteAsn": 0,
- "remoteIpAddress": "string",
- "state": "string",
- "uuid": "string",
- "virtualDeviceUuid": "string"
}
Create VPN Configuration
Creates a VPN configuration. You must have a provisioned virtual device with a registered license to create a VPN.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
VPN info
siteName required | string | ||||||||||||||||
virtualDeviceUuid required | string The unique Id of the primary device. | ||||||||||||||||
configName | string | ||||||||||||||||
peerIp required | string | ||||||||||||||||
peerSharedKey required | string | ||||||||||||||||
remoteAsn required | integer <int64> Remote Customer ASN - Customer side | ||||||||||||||||
remoteIpAddress required | string Remote Customer IP Address - Customer side | ||||||||||||||||
password required | string BGP Password | ||||||||||||||||
localAsn | integer <int64> Local ASN - Equinix side | ||||||||||||||||
tunnelIp required | string Local Tunnel IP Address in CIDR format | ||||||||||||||||
object (VpnRequest) | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "siteName": "Chicago",
- "virtualDeviceUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "configName": "Traffic from AWS cloud",
- "peerIp": "110.11.12.222",
- "peerSharedKey": "5bb2424e888bd",
- "remoteAsn": 65413,
- "remoteIpAddress": "100.210.1.31",
- "password": "pass123",
- "localAsn": 65414,
- "tunnelIp": "192.168.7.2/30",
- "secondary": {
- "configName": "Traffic from AWS cloud",
- "peerIp": "110.11.12.222",
- "peerSharedKey": "5bb2424e888bd",
- "remoteAsn": 65413,
- "remoteIpAddress": "100.210.1.31",
- "password": "pass123",
- "localAsn": 65414,
- "tunnelIp": "192.168.7.2/30"
}
}
Response samples
- 400
- 403
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Get VPN Configurations
Gets all VPN configurations by user name and specified parameter(s). Authorization checks are performed on the users of this API.
query Parameters
statusList | Array of strings One or more desired status |
virtualDeviceUuid | string Unique Id of a virtual device |
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (VpnResponse) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Response samples
- 200
- 403
- 500
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "siteName": "Chicago",
- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "virtualDeviceUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "configName": "Traffic from AWS cloud",
- "status": "PROVISIONED",
- "peerIp": "110.11.12.222",
- "peerSharedKey": "5bb2424e888bd",
- "remoteAsn": 65413,
- "remoteIpAddress": "100.210.1.31",
- "password": "pass123",
- "localAsn": 65414,
- "tunnelIp": "192.168.7.2/30",
- "bgpState": "ESTABLISHED",
- "inboundBytes": "8780",
- "inboundPackets": "8780",
- "outboundBytes": "8765",
- "outboundPackets": "8765",
- "tunnelStatus": "UP",
- "custOrgId": 65555,
- "createdDate": "2018-05-18 06:34:26",
- "createdByFirstName": "John",
- "createdByLastName": "Smith",
- "createdByEmail": "alpha@beta.com",
- "createdByUserKey": 123,
- "createdByAccountUcmId": 456,
- "createdByUserName": "jsmith",
- "createdByCustOrgId": 7863,
- "createdByCustOrgName": "My Awesome Org",
- "createdByUserStatus": "ACTIVATED",
- "createdByCompanyName": "My Awesome Company",
- "lastUpdatedDate": "2018-07-21 05:20:20",
- "updatedByFirstName": "John",
- "updatedByLastName": "Smith",
- "updatedByEmail": "alpha@beta.com",
- "updatedByUserKey": 123,
- "updatedByAccountUcmId": 456,
- "updatedByUserName": "jsmith",
- "updatedByCustOrgId": 7863,
- "updatedByCustOrgName": "My Awesome Org",
- "updatedByUserStatus": "ACTIVATED",
- "updatedByCompanyName": "My Awesome Company"
}
]
}
Get VPN Configuration {uuid}
Gets a VPN configuration by its unique Id. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
siteName required | string |
uuid | string |
virtualDeviceUuid required | string |
configName | string |
status | string |
peerIp required | string |
peerSharedKey required | string |
remoteAsn required | integer <int64> Remote Customer ASN - Customer side |
remoteIpAddress required | string Remote Customer IP Address - Customer side |
password required | string BGP Password |
localAsn | integer <int64> Local ASN - Equinix side |
tunnelIp required | string Local Tunnel IP Address in CIDR format |
bgpState | string |
inboundBytes | string |
inboundPackets | string |
outboundBytes | string |
outboundPackets | string |
tunnelStatus | string |
custOrgId | integer <int64> |
createdDate | string |
createdByFirstName | string |
createdByLastName | string |
createdByEmail | string |
createdByUserKey | integer <int64> |
createdByAccountUcmId | integer <int64> |
createdByUserName | string |
createdByCustOrgId | integer <int64> |
createdByCustOrgName | string |
createdByUserStatus | string |
createdByCompanyName | string |
lastUpdatedDate | string |
updatedByFirstName | string |
updatedByLastName | string |
updatedByEmail | string |
updatedByUserKey | integer <int64> |
updatedByAccountUcmId | integer <int64> |
updatedByUserName | string |
updatedByCustOrgId | integer <int64> |
updatedByCustOrgName | string |
updatedByUserStatus | string |
updatedByCompanyName | string |
Response samples
- 200
- 403
- 404
- 500
{- "siteName": "Chicago",
- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "virtualDeviceUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "configName": "Traffic from AWS cloud",
- "status": "PROVISIONED",
- "peerIp": "110.11.12.222",
- "peerSharedKey": "5bb2424e888bd",
- "remoteAsn": 65413,
- "remoteIpAddress": "100.210.1.31",
- "password": "pass123",
- "localAsn": 65414,
- "tunnelIp": "192.168.7.2/30",
- "bgpState": "ESTABLISHED",
- "inboundBytes": "8780",
- "inboundPackets": "8780",
- "outboundBytes": "8765",
- "outboundPackets": "8765",
- "tunnelStatus": "UP",
- "custOrgId": 65555,
- "createdDate": "2018-05-18 06:34:26",
- "createdByFirstName": "John",
- "createdByLastName": "Smith",
- "createdByEmail": "alpha@beta.com",
- "createdByUserKey": 123,
- "createdByAccountUcmId": 456,
- "createdByUserName": "jsmith",
- "createdByCustOrgId": 7863,
- "createdByCustOrgName": "My Awesome Org",
- "createdByUserStatus": "ACTIVATED",
- "createdByCompanyName": "My Awesome Company",
- "lastUpdatedDate": "2018-07-21 05:20:20",
- "updatedByFirstName": "John",
- "updatedByLastName": "Smith",
- "updatedByEmail": "alpha@beta.com",
- "updatedByUserKey": 123,
- "updatedByAccountUcmId": 456,
- "updatedByUserName": "jsmith",
- "updatedByCustOrgId": 7863,
- "updatedByCustOrgName": "My Awesome Org",
- "updatedByUserStatus": "ACTIVATED",
- "updatedByCompanyName": "My Awesome Company"
}
Update VPN Configuration
Update a VPN configuration by its unique Id. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
VPN info
siteName required | string | ||||||||||||||||
virtualDeviceUuid required | string The unique Id of the primary device. | ||||||||||||||||
configName | string | ||||||||||||||||
peerIp required | string | ||||||||||||||||
peerSharedKey required | string | ||||||||||||||||
remoteAsn required | integer <int64> Remote Customer ASN - Customer side | ||||||||||||||||
remoteIpAddress required | string Remote Customer IP Address - Customer side | ||||||||||||||||
password required | string BGP Password | ||||||||||||||||
localAsn | integer <int64> Local ASN - Equinix side | ||||||||||||||||
tunnelIp required | string Local Tunnel IP Address in CIDR format | ||||||||||||||||
object (VpnRequest) | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "siteName": "Chicago",
- "virtualDeviceUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "configName": "Traffic from AWS cloud",
- "peerIp": "110.11.12.222",
- "peerSharedKey": "5bb2424e888bd",
- "remoteAsn": 65413,
- "remoteIpAddress": "100.210.1.31",
- "password": "pass123",
- "localAsn": 65414,
- "tunnelIp": "192.168.7.2/30",
- "secondary": {
- "configName": "Traffic from AWS cloud",
- "peerIp": "110.11.12.222",
- "peerSharedKey": "5bb2424e888bd",
- "remoteAsn": 65413,
- "remoteIpAddress": "100.210.1.31",
- "password": "pass123",
- "localAsn": 65414,
- "tunnelIp": "192.168.7.2/30"
}
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Delete VPN Configuration
Deletes a VPN configuration by its unique Id. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string uuid |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Get Backups of Device
Returns the backups of a virtual device. Authorization checks are performed on the users of this API.
query Parameters
virtualDeviceUuid required | string Unique ID of a virtual device |
status | Array of strings An array of status values |
offset | string <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
limit | string <int32> Default: 20 Specifies the page size. |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object (PaginationResponseDto) | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (DeviceBackupInfoVerbose) | |||||||||||||||||||||||
Array
|
Response samples
- 200
- 403
- 500
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "name": "My New Backup",
- "version": "16.09.02",
- "type": "CONFIG",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "lastUpdatedDate": "2018-01-30T10:30:31.387Z",
- "downloadUrl": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download",
- "deleteAllowed": true,
- "restores": [
- {
- "uuid": "7hgj5675-5c3f-4275-adba-0c9e3c26c45y",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "createdDate": "2018-01-30T10:30:31.387Z",
- "lastUpdatedDate": "2018-01-30T10:30:31.387Z"
}
], - "deviceUuid": "78fb5675-5c3f-4275-adba-0c9e3c26c78c"
}
]
}
Creates Device Backup
Creates the backup of a virtual device. Authorization checks are performed on the users of this API.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Device backup info
deviceUuid required | string The unique Id of a virtual device. |
name required | string The name of backup. |
Responses
Request samples
- Payload
{- "deviceUuid": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8",
- "name": "My New Backup"
}
Response samples
- 202
- 400
- 403
- 500
{- "uuid": "12828472-e6e9-4f2b-98f7-b79cf0fab4ff"
}
Get Backups of Device {uuid}
Returns the details of a backup by its unique ID. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string Unique ID of a backup |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
uuid | string The unique Id of the device backup. | ||||||||||
name | string The name of the backup. | ||||||||||
version | string Version of the device | ||||||||||
type | string The type of backup. | ||||||||||
status | string The status of the backup. | ||||||||||
createdBy | string Created by. | ||||||||||
lastUpdatedDate | string Last updated date. | ||||||||||
downloadUrl | string URL where you can download the backup. | ||||||||||
deleteAllowed | boolean Whether or not you can delete the backup. | ||||||||||
Array of objects (PreviousBackups) | |||||||||||
Array
| |||||||||||
deviceUuid | string Unique Id of the device |
Response samples
- 200
- 400
- 500
{- "uuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "name": "My New Backup",
- "version": "16.09.02",
- "type": "CONFIG",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "lastUpdatedDate": "2018-01-30T10:30:31.387Z",
- "downloadUrl": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download",
- "deleteAllowed": true,
- "restores": [
- {
- "uuid": "7hgj5675-5c3f-4275-adba-0c9e3c26c45y",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "createdDate": "2018-01-30T10:30:31.387Z",
- "lastUpdatedDate": "2018-01-30T10:30:31.387Z"
}
], - "deviceUuid": "78fb5675-5c3f-4275-adba-0c9e3c26c78c"
}
Update Device Backup
Updates the name of a backup. Authorization checks are performed on users of this API.
path Parameters
uuid required | string Unique ID of a backup |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Update device backup
name required | string The name of backup. |
Responses
Request samples
- Payload
{- "name": "My New Backup"
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Delete Backup of Device
Deletes a backup by its unique ID. Authorization checks are performed on users of this API.
path Parameters
uuid required | string Unique Id a backup |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 400
- 403
- 404
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Download a Backup
Downloads the backup of a device by its backup ID. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string Unique ID of a backup |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
The configuration of the device in a string format.
Response samples
- 200
- 400
- 500
"Current configuration 9531 bytes"
Checks Feasibility of Restore
Checks the feasibility of restoring the backup of a virtual device. Authorization checks are performed on the users of this API.
path Parameters
uuid required | string Unique ID of a device |
query Parameters
backupUuid required | string Unique ID of a backup |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
object An object that has the device backup details. | |||||||||||||
| |||||||||||||
object An object that has the analysis of services associated with the backup or services added to the device since the backup. | |||||||||||||
| |||||||||||||
restoreAllowedAfterDeleteOrEdit | boolean If True, the backup is restorable once you perform the recommended opertions. If False, the backup is not restorable. |
Response samples
- 200
- 400
- 500
{- "deviceBackup": {
- "deviceBackup": {
- "uuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "name": "My New Backup",
- "status": "COMPLETED",
- "deleteAllowed": true
}
}, - "services": {
- "service_name": {
- "serviceId": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "serviceName": "L2 Connection with AWS",
- "operationNeededToPerform": "DELETE"
}
}, - "restoreAllowedAfterDeleteOrEdit": false
}
Restores a backup
Restores any backup of a device. Authorization checks are performed on users of this API.
path Parameters
uuid required | string Unique ID of a backup |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Update device backup
name required | string The name of backup. |
Responses
Request samples
- Payload
{- "name": "My New Backup"
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Trigger Device RMA
Triggers a request to create an RMA of a device. The payload to create an RMA is different for different vendors. You will need to enter a license to create an RMA.
path Parameters
virtualDeviceUuid required | string Unique ID of a device |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/jsonrequired
Post RMA request
version required | string Any version you want. | ||||||||||||||||||||
cloudInitFileId | string For a C8KV device, this is the Id of the uploaded bootstrap file. Upload your Cisco bootstrap file by calling Upload File. In the response, you'll get a fileUuid that you can enter here as cloudInitFileId. This field may be required for some vendors. | ||||||||||||||||||||
licenseFileId | string This is the Id of the uploaded license file. For a CSR1KV SDWAN device, upload your license file by calling Post License File. In the response, you'll get a fileId that you can enter here as licenseFileId. This field may be required for some vendors. | ||||||||||||||||||||
token | string License token. For a cluster, you will need to provide license tokens for both node0 and node1. To get the exact payload for different vendors, check the Postman script on the API Reference page of online documentation. | ||||||||||||||||||||
object (RMAVendorConfig) | |||||||||||||||||||||
| |||||||||||||||||||||
object (UserPublicKeyRequest) An object with public key details. | |||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "version": "17.09.01a",
- "cloudInitFileId": "029a0bcd-0b2f-4bc5-b875-b506aa4b9738",
- "licenseFileId": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730",
- "token": "897gjikk888",
- "vendorConfig": {
- "siteId": 567,
- "systemIpAddress": "192.164.0.0",
- "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
- "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
- "controller1": "54.219.248.29",
- "adminPassword": "ZQeIDI7sUd",
- "activationKey": "GJUK-JM2X-59BJ-2TDJ",
- "provisioningKey": "provisioningKeysample",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": 123456
}, - "userPublicKey": {
- "username": "test-user-1",
- "keyName": "test-pk-2"
}
}
Response samples
- 400
- 403
- 500
{- "errorCode": "string",
- "errorMessage": "string",
- "moreInfo": "string",
- "property": "string",
- "status": "string"
}
Get Downloadable Images
Returns the downloadable images of a device type. Pass any device type as a path parameter to get the list of downloadable images.
path Parameters
deviceType required | string Device type |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
uuid | string The unique Id of the downloadable link. |
deviceType | string Device type. As of now, we only support C8000V. |
imageName | string Device type. As of now, we only support C8000V. |
version | string Device version |
Response samples
- 200
- 400
- 500
[- {
- "uuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceType": "C8000V",
- "imageName": "CiscoSyst-C8000VCon-17.11.01a-3270",
- "version": "17.11.01a"
}
]
Download an Image
Returns a link to download image. You need to provide a device type and version as path parameters.
path Parameters
deviceType required | string Device type |
version required | string Version |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response samples
- 202
- 400
- 403
- 500
{
}