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.
APIs for setting up the environment, including device types and metros.
Returns device types (e.g., routers and firewalls) that can be launched on the NE platform.
| deviceTypeCode | string Enum: "C8000V" "CSR1000V" "PA-VM" "ASAV" "ISR1100" "VSRX" "FG-VM" "EDGE" Example: deviceTypeCode=C8000V Device type code (e.g., C8000V) |
| category | string Example: category=ROUTER Category. One of FIREWALL, ROUTER or SD-WAN |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | Array of objects (VirtualDeviceType) Array of available virtual device types | ||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "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": 20,
- "defaultInterfaceCount": 10,
- "clusterMaxInterfaceCount": 100,
- "clusterDefaultInterfaceCount": 50,
- "availableMetros": [
- {
- "metroCode": "DC",
- "metroDescription": "Ashburn",
- "region": "AMER",
- "clusterSupported": false
}
], - "softwarePackages": [
- {
- "name": "Security",
- "packageCode": "SEC",
- "licenseType": "BYOL",
- "versionDetails": [
- {
- "cause": { },
- "version": "16.09.02",
- "imageName": "csr-16.09.02",
- "versionDateTime": "2019-01-01T00:00:00Z",
- "retireDateTime": "2024-12-12T00:00:00Z",
- "status": "ACTIVE",
- "stableVersion": true,
- "allowedUpgradableVersions": [
- "16.09.03"
], - "supportedLicenseTypes": [
- "BYOL",
- "Subscription"
]
}
]
}
], - "deviceManagementTypes": [
- "SELF-CONFIGURED"
]
}
]
}Returns the interface details for a device type with a chosen configuration. You must pass the device type as the path parameter.
| deviceType required | string Enum: "C8000V" "PA-VM" "ISR1100" "VSRX" "FG-VM" "VERSA_SDWAN" "PRISMA-SDWAN" "FG-SDWAN" "CGUARD" "NGINX" "MERAKI-VMX-GA" "INFOBLOX-GRID-MEMBER" "VYOS-ROUTER" "ARISTA-ROUTER" "C8000V-SDWAN" "AVIATRIX_EDGE" Example: PA-VM Device type code. PA-VM. |
| deviceManagementType required | string Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Example: deviceManagementType=SELF-CONFIGURED Device management type. SELF-CONFIGURED |
| mode | string Enum: "Subscription" "BYOL" Example: mode=Subscription 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 Enum: "INTERNET-ACCESS" "PRIVATE" "INTERNET-ACCESS-WITH-PRVT-MGMT" Example: connectivity=INTERNET-ACCESS Type of connectivity you want. INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. PRIVATE devices do not have ACLs or bandwidth. |
| core | integer Example: core=4 The desired number of cores. |
| memory | integer Example: memory=4 Desired memory. |
| unit | string Example: unit=GB Unit of memory. GB or MB. |
| flavor | string Example: flavor=small Flavor of device. |
| version | string Example: version=17.06.01 Version. |
| softwarePkg | string Example: softwarePkg=SEC Software package. |
Array of objects (AllowedInterfaceProfiles) List of allowed interface profiles | |||||||
Array
| |||||||
{- "interfaceProfiles": [
- {
- "count": 10,
- "interfaces": [
- {
- "name": "ethernet1/1",
- "description": "DATA Interface",
- "interfaceId": "2",
- "status": "AVAILABLE"
}
], - "default": true
}
]
}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.
| region | string Example: region=AMER Name of the region for which you want metros (e.g., AMER) |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||
| |||||||||
required | Array of objects (MetroResponse) Array of available metros | ||||||||
Array
| |||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "metroCode": "SV",
- "metroDescription": "Silicon Valley",
- "region": "AMER",
- "clusterSupported": false
}
]
}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".
| metro required | string Example: SV Metro region for which you want to check your account status |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 Unique ID of an account |
| accountCreateUrl | string The URL to create a new account | ||||||||||||||
Array of objects (MetroAccountResponse) List of metro accounts | |||||||||||||||
Array
| |||||||||||||||
| errorMessage | string Error message | ||||||||||||||
| errorCode | string Error code | ||||||||||||||
object (PaginationResponse) | |||||||||||||||
| |||||||||||||||
{- "data": [
- {
- "accountName": "nfv1",
- "accountNumber": 2252619,
- "accountUcmId": "92D27009-EA33-4b60-B4FB-D3C4ED589649",
- "accountStatus": "ACTIVE",
- "metros": [
- "DA"
], - "creditHold": false,
- "referenceId": "null"
}
], - "errorMessage": "Invalid input",
- "errorCode": "EQ-4001530",
- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}
}Call this API to find out the status of your agreement, whether it is valid or not, or to just read the agreement terms.
| accountNumber | string Example: accountNumber=123456 Unique identifier of the customer account. |
| errorMessage | string Error message if agreement is invalid |
| isValid required | boolean Whether the agreement is valid |
| terms | string Agreement terms |
| termsVersionID | string Agreement terms version ID |
{- "errorMessage": "null",
- "isValid": true,
- "terms": "null",
- "termsVersionID": "null"
}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.
agreementAcceptRequest
| accountNumber | string Account number. |
| apttusId | string The version number of the agreement. |
| status | string Enum: "SUCCESS" "FAILED" Status of the request. |
{- "accountNumber": "456446",
- "apttusId": "c2Z34000002CXRm"
}{- "status": "SUCCESS"
}Returns a link to a vendor's terms. The term "vendor" refers to the vendor of a virtual device on the Network Edge platform.
| vendorPackage | string Enum: "VM02" "VM03" "NETWORK-ESSENTIALS" Example: vendorPackage=NETWORK-ESSENTIALS The vendor package code. |
| licenseType | string Enum: "Subscription" "BYOL" Example: licenseType=Subscription The type of license (e.g., Subscription, BYOL). |
| terms | string Vendor terms URL |
Retrieves the terms and conditions of orders. Please read the terms and conditions before placing an order.
| terms | string Order terms |
{- "terms": "By clicking \"Accept\" you are agreeing to the terms and conditions of this Order on behalf of your Company. You are acknowledging that you have the full authority on behalf of your Company to enter into this online Order \"Order\" as governed by and incorporated by reference into the applicable Master Country Agreement, Interconnection Terms and Conditions, or other similar agreement agreed to between the Parties \"Agreement.\" Unless otherwise defined in this Order or if the context requires otherwise, all capitalized terms used in this Order shall have the meanings ascribed to them in the Agreement.‘Product(s)’ as used in this Order means all the products under this Order, including Licensed Space and/or Services (if any). The Initial Term is the term stated above, which commence on the date the Product(s) are delivered (“Effective Date”). After the Initial Term, the term will automatically renew for a period equal to the Initial Term unless either Party terminates this Order by providing written non-renewal notice 90 days prior to the end of the then-current term to the other Party in which event this Order will terminate at the end of the then-current term. For avoidance of doubt, the notice period for an Initial Term of one month is 30 days, rather than 90 days. This Order incorporates the Product Provider EULA provided by Equinix to the Customer in Attachment A of this Order and the Product Policies, which are attached as Exhibits to the Customer’s Interconnection Terms and Conditions. All Product(s) selected as part of this Order are subject to availability. Equinix, in its sole discretion, reserves the right to reject any handwritten or typed modification to this Agreement or any Order which is not mutually agreed to in writing. For purposes of this Order, the Parties hereby agree that the following ‘Price Increase Terms’ grid is not applicable to the Network Edge Service and is of no force or effect. If you have any questions regarding the terms of this Order, please contact your Equinix Sales Representative. A PRODUCT PROVIDER EULABy clicking \\\"Accept\\\" you are agreeing to the terms and conditions of this Order on behalf of your Company. You are acknowledging that you have the full authority on behalf of your Company to enter into this online Order (\\\"Order\\\") as governed by and incorporated by reference into the applicable Master Country Agreement, Interconnection Terms and Conditions, or other similar agreement agreed to between the Parties (\\\"Agreement\\\"). Unless otherwise defined in this Order or if the context requires otherwise, all capitalized terms used in this Order shall have the meanings ascribed to them in the Agreement.\\r\\n‘Product(s)’ as used in this Order means all the products under this Order, including Licensed Space and/or Services (if any). The Initial Term is the term stated above, which commence on the date the Product(s) are delivered (“Effective Date”). \\r\\n\\r\\nAfter the Initial Term, the term will automatically renew for a period equal to the Initial Term unless either Party terminates this Order by providing written non-renewal notice 90 days prior to the end of the then-current term to the other Party in which event this Order will terminate at the end of the then-current term. For the avoidance of doubt, the notice period for an Initial Term of one month is 30 days, rather than 90 days. \\r\\n\\r\\n\\r\\nThis Order incorporates the Product Provider EULA provided by Equinix to the Customer in Attachment A of this Order and the Product Policies, which are attached as Exhibits to the Customer’s Interconnection Terms and Conditions . All Product(s) selected as part of this Order are subject to availability.\\r\\n\\r\\nEquinix, in its sole discretion, reserves the right to reject any handwritten or typed modification to this Agreement or any Order which is not mutually agreed to in writing. For purposes of this Order, the Parties hereby agree that the following ‘Price Increase Terms’ grid is not applicable to the Network Edge Service and is of no force or effect. If you have any questions regarding the terms of this Order, please contact your Equinix Sales Representative. ATTACHMENT A PRODUCT PROVIDER EULA"
}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.
| accountNumber | integer <int32> Example: accountNumber=123456 Account number |
| metro | string Example: metro=SV Metro |
| vendorPackage | string Enum: "VM02" "VM03" "NETWORK-ESSENTIALS" Example: vendorPackage=NETWORK-ESSENTIALS Vendor package |
| licenseType | string Enum: "Subscription" "BYOL" Example: licenseType=Subscription License type |
| softwarePackage | string Example: softwarePackage=AX Software package |
| throughput | integer <int32> Example: throughput=100 Throughput |
| throughputUnit | string Example: throughputUnit=Mbps Throughput unit |
| termLength | string Example: termLength=12 Term length (in months) |
| additionalBandwidth | integer <int32> Example: additionalBandwidth=100 Additional bandwidth (in Mbps) |
| virtualDeviceUuid | string Example: virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Virtual device unique Id (only required if existing device is being modified) |
| deviceManagementType | string Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Example: deviceManagementType=SELF-CONFIGURED The device management type |
| core | integer <int32> Example: core=4 The number of cores |
| secondaryAccountNumber | integer <int32> Example: secondaryAccountNumber=123457 The secondary account number (for HA) |
| secondaryMetro | string Example: secondaryMetro=SV Secondary metro (for HA) |
| secondaryAdditionalBandwidth | integer <int32> Example: secondaryAdditionalBandwidth=100 Secondary additional bandwidth (in Mbps for HA) |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 Account unique ID |
| orderingContact | string Example: orderingContact=cust0001 Reseller customer username |
object (PriceResponse) Pricing details response | |||||||||||||||
| |||||||||||||||
object (PriceResponse) Pricing details response | |||||||||||||||
| |||||||||||||||
| termLength | string Term length in months. | ||||||||||||||
{- "primary": {
- "billingCommencementDateTime": "2023-11-10T19:06:06Z",
- "billingEnabled": true,
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": "200"
}
], - "currency": "USD"
}, - "secondary": {
- "billingCommencementDateTime": "2023-11-10T19:06:06Z",
- "billingEnabled": true,
- "charges": [
- {
- "description": "VIRTUAL_DEVICE",
- "monthlyRecurringCharges": "200"
}
], - "currency": "USD"
}, - "termLength": "24"
}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
| accountNumber | integer <int32> Example: accountNumber=123456 Account number |
| metro | string Example: metro=SV Metro |
| vendorPackage | string Enum: "VM02" "VM03" "NETWORK-ESSENTIALS" Example: vendorPackage=NETWORK-ESSENTIALS Vendor package |
| licenseType | string Enum: "Subscription" "BYOL" Example: licenseType=Subscription License type |
| softwarePackage | string Example: softwarePackage=AX Software package |
| throughput | integer <int32> Example: throughput=100 Throughput |
| throughputUnit | string Example: throughputUnit=Mbps Throughput unit |
| termLength | string Example: termLength=12 Term length (in months) |
| additionalBandwidth | integer <int32> Example: additionalBandwidth=100 Additional bandwidth (in Mbps) |
| virtualDeviceUuid | string Example: virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Virtual device unique Id (only required if existing device is being modified) |
| deviceManagementType | string Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Example: deviceManagementType=SELF-CONFIGURED The device management type |
| core | integer <int32> Example: core=4 The number of cores |
| secondaryAccountNumber | integer <int32> Example: secondaryAccountNumber=123457 Secondary account number (in case you have a device pair) |
| secondaryMetro | string Example: secondaryMetro=SV Secondary metro (in case you have a device pair) |
| secondaryAdditionalBandwidth | integer <int32> Example: secondaryAdditionalBandwidth=100 Secondary additional bandwidth (in Mbps) |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 Account unique ID |
| orderingContact | string Example: orderingContact=cust0001 Reseller customer username |
| data | Array of objects | ||||||
object (PaginationResponse) | |||||||
| |||||||
{- "data": [
- { }
], - "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}
}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.
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 This field is for resellers. Please pass the accountUcmId of your customer to get the public keys. |
required | object (PaginationResponse) | ||||||||
| |||||||||
required | Array of objects (PublicKeyResponse) Array of available public keys | ||||||||
Array
| |||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "keyName": "myKeyName",
- "keyValue": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname",
- "keyType": "RSA"
}
]
}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.
keyName, keyValue, and keyType
| keyName required | string Key name |
| keyValue required | string Key value |
| keyType | string Enum: "RSA" "DSA" Key type, whether RSA or DSA. Default is RSA. |
| Location | string Example: "/ne/v1/publicKeys/877a3aa2-c49a-4af1-98a6-007424e737ae" URL of the created public key. |
| uuid | string The unique Id of the keyName and keyValue combination |
| keyName | string Key name |
| keyValue | string Key value |
| keyType | string Enum: "RSA" "DSA" Type of key, whether RSA or DSA |
{- "keyName": "myKeyName",
- "keyValue": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname",
- "keyType": "RSA"
}{- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
- "keyName": "myKeyName",
- "keyValue": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname",
- "keyType": "RSA"
}Returns all planned and unplanned downtime notifications related to APIs and infrastructure. Please pass a token in the header.
| notificationType | string Enum: "PLANNED" "UNPLANNED" Type of notification, whether planned or unplanned. | ||||||||||
| startDateTime | string <date-time> Start of the downtime. | ||||||||||
| endDateTime | string <date-time> End of the downtime. | ||||||||||
Array of objects (ImpactedServices) An array of services impacted by the downtime. | |||||||||||
Array
| |||||||||||
| additionalMessage | string Any additional messages. | ||||||||||
{- "notificationType": "PLANNED",
- "startDateTime": "2019-08-27T17:30:00Z",
- "endDateTime": "2019-08-27T17:30:00Z",
- "impactedServices": [
- {
- "serviceName": "Device",
- "impact": "Device",
- "serviceStartDateTime": "2019-08-27T17:30:00Z",
- "serviceEndDateTime": "2019-08-27T17:30:00Z",
- "errorMessage": "Create device APIs are currently down."
}
], - "additionalMessage": "Network Edge APIs are currently unavailable. Please try again later."
}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.
| deviceManagementType | string Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Device management type, whether SELF-CONFIGURED or EQUINIX-CONFIGURED |
| file required | string <binary> A license or a cloud_init file. |
| licenseType | string Value: "BYOL" Type of license (BYOL-Bring Your Own License) |
| metroCode required | string Two-letter metro code. |
| deviceTypeCode required | string Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Device type code, e.g., C8000V |
| processType required | string Enum: "LICENSE" "CLOUD_INIT" Whether you are uploading a license or a cloud_init file. LICENSE or CLOUD_INIT |
| fileUuid | string The unique ID of the uploaded file. |
{- "fileUuid": "029a0bcd-0b2f-4bc5-b875-b506aa4b9738"
}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.
| metroCode required | string Example: metroCode=SV Two-letter metro code where the device will be created. |
| deviceTypeCode required | string Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Example: deviceTypeCode=C8000V Device type code (e.g., C8000V). |
| licenseType required | string Value: "BYOL" Example: licenseType=BYOL Type of license (e.g., BYOL). |
| file required | string <binary> License file |
| fileId | string The unique ID of the uploaded license file. |
{- "fileId": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730"
}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.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device |
| file required | string <binary> License file |
| fileId | string The unique ID of the uploaded license file. |
{- "fileId": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730"
}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.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device |
License token
| token | string |
{- "token": "A1025025"
}{- "fileId": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730"
}Returns all the available virtual devices, i.e. routers and routers, on the Network Edge platform.
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
| metroCode | string Example: metroCode=SV Two-letter metro code. |
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" Example: status=PROVISIONED The status of the device. |
| showOnlySubCustomerDevices | boolean Resellers may mark this Yes to see sub customer devices. |
| accountUcmId | string Example: accountUcmId=123456 Unique ID of the account. |
| searchText | string Example: searchText=My-Device Enter text to fetch only matching device names |
| sort | Array of strings Example: sort=name Sorts the output based on field names. |
required | object (PaginationResponse) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (VirtualDeviceDetailsResponse) Array of available virtual devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "accountName": "ABC INC",
- "accountNumber": "133911",
- "createdBy": "cust0001",
- "createdDateTime": "2018-01-30T10:30:31Z",
- "deletedBy": "cust0001",
- "deletedDateTime": "2018-01-30T10:30:31Z",
- "deviceSerialNo": "53791666484",
- "deviceTypeCategory": "ROUTER",
- "diverseFromDeviceName": "My-Other-Device",
- "diverseFromDeviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceTypeCode": "C8000V",
- "deviceTypeName": "C8000V",
- "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",
- "lastUpdatedDateTime": "2018-01-30T10:30:31Z",
- "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": "user123",
- "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": "21913599",
- "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"
}
]
}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.
| draft | boolean Default: false Whether to save this as a draft. |
| draftUuid | string Example: draftUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 The unique ID of the draft to be promoted to a device. |
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 Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" 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 Enum: "SUB" "BYOL" 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 Username of the ordering contact. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| core required | integer <int32> The desired number of cores. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interfaceCount | integer <int32> The desired number of interfaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| siteId | string Site ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| systemIpAddress | string System IP address. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VendorConfig) Vendor-specific configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserPublicKeyRequest) An object with public key details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ipType | string Value: "STATIC" 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) Cluster configuration details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| primaryDeviceUuid | string This field is mandatory if you are using this API to add a secondary device to an existing primary device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| connectivity | string Enum: "INTERNET-ACCESS" "PRIVATE" "INTERNET-ACCESS-WITH-PRVT-MGMT" 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) Request to create a secondary HA device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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": "12",
- "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": 4,
- "interfaceCount": 10,
- "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": "user123",
- "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": "21913599",
- "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": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "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": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "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@equinix.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": "user123",
- "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": "21913599",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": "123456"
}, - "sshInterfaceId": "4",
- "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691"
}
}{- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae"
}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.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 uuid |
| accountName | string Account name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| accountNumber | string Account number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| createdBy | string Created by user | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| createdDateTime | string <date-time> Date and time of creation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deletedBy | string Deleted by user | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deletedDateTime | string <date-time> Date and time of deletion | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deviceSerialNo | string Device serial number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deviceTypeCategory | string Enum: "ROUTER" "FIREWALL" "SDWAN" Device type category (e.g., ROUTER, FIREWALL) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Device type code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deviceTypeName | string Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Device type name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| expiry | string Expiry time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| region | string Region | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deviceTypeVendor | string Enum: "CISCO" "PALO_ALTO_NETWORKS" "JUNIPER" "FORTINET" "ARISTA" "ARUBA" "F5" "BLUECAT" "ZSCALER" "CHECK_POINT" "VMWARE" "SILVER_PEAK" "VERSA_NETWORKS" "AVIATRIX" Device type vendor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| hostName | string Host name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uuid | string Device UUID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lastUpdatedBy | string Last updated by user | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lastUpdatedDateTime | string <date-time> Date and time of last update | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| licenseFileId | string License file ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| licenseName | string License name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| licenseStatus | string Enum: "REGISTERED" "UNREGISTERED" "PENDING" "EXPIRED" License status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| licenseType | string Enum: "BYOL" "SUB" License type (e.g., BYOL, SUB) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| metroCode | string Metro code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| metroName | string Metro name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | string Device name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notifications | Array of strings List of notifications | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| packageCode | string Package code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| packageName | string Package name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| version | string Device version | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purchaseOrderNumber | string Purchase order number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| redundancyType | string Enum: "PRIMARY" "SECONDARY" Redundancy type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| redundantUuid | string Redundant device UUID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| connectivity | string Connectivity type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sshIpAddress | string SSH IP address | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sshIpFqdn | string SSH IP FQDN | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sshIpFqdnStatus | string Enum: "ASSIGNED" "UNASSIGNED" SSH IP FQDN status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" Device status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| throughput | integer <int32> Throughput | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| throughputUnit | string Throughput unit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (CoresDisplayConfig) Core configuration details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (PricingSiebelConfig) An object that has the pricing and other details of a Siebel order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interfaceCount | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| deviceManagementType | string Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Device management type (e.g., SELF-CONFIGURED, EQUINIX-CONFIGURED) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plane | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserPublicKeyConfig) An object with public key details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| managementIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| managementGatewayIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| publicIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| publicGatewayIp | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| primaryDnsName | string Primary DNS name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| secondaryDnsName | string Secondary DNS name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| termLength | string Term length in months. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| newTermLength | string The term length effective upon the expiration of the current term. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| additionalBandwidth | string Additional bandwidth | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| siteId | string Site ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| systemIpAddress | string System IP address | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VendorConfig) Vendor-specific configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (InterfaceBasicInfoResponse) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| asn | number The ASN number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| channelPartner | string The name of the channel partner. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "accountName": "ABC INC",
- "accountNumber": "133911",
- "createdBy": "cust0001",
- "createdDateTime": "2018-01-30T10:30:31Z",
- "deletedBy": "cust0001",
- "deletedDateTime": "2018-01-30T10:30:31Z",
- "deviceSerialNo": "53791666484",
- "deviceTypeCategory": "ROUTER",
- "diverseFromDeviceName": "My-Other-Device",
- "diverseFromDeviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceTypeCode": "C8000V",
- "deviceTypeName": "C8000V",
- "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",
- "lastUpdatedDateTime": "2018-01-30T10:30:31Z",
- "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": "user123",
- "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": "21913599",
- "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"
}This API is for updating a virtual device draft
and does not support device update as of now.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a Virtual Device |
| draft required | boolean Example: draft=true draft |
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 Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" 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 Enum: "SUB" "BYOL" 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 Username of the ordering contact. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 Enum: "SELF-CONFIGURED" "EQUINIX-CONFIGURED" Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| core required | integer <int32> The desired number of cores. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| interfaceCount | integer <int32> The desired number of interfaces. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| siteId | string Site ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| systemIpAddress | string System IP address. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (VendorConfig) Vendor-specific configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (UserPublicKeyRequest) An object with public key details. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ipType | string Value: "STATIC" 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) Cluster configuration details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| primaryDeviceUuid | string This field is mandatory if you are using this API to add a secondary device to an existing primary device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| connectivity | string Enum: "INTERNET-ACCESS" "PRIVATE" "INTERNET-ACCESS-WITH-PRVT-MGMT" 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) Request to create a secondary HA device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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": "12",
- "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": 4,
- "interfaceCount": 10,
- "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": "user123",
- "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": "21913599",
- "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": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "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": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
- "licenseToken": "V74191621",
- "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@equinix.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": "user123",
- "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": "21913599",
- "panoramaIpAddress": "1.1.1.1",
- "panoramaAuthKey": "123456"
}, - "sshInterfaceId": "4",
- "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691"
}
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]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.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a Virtual Device |
| deleteRedundantDevice | boolean Default: false Optional parameter in case you have a secondary device. As both the primary and secondary devices are deleted simultaneously, this field must be marked True so we delete both the devices simultaneously. |
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) Request to delete a secondary virtual device | |||
| |||
{- "deactivationKey": "8dfbd5ba3610234d9e550032603cc34762af140533e2c1de0111d3451d16eefd",
- "secondary": {
- "deactivationKey": "8dfbd5ba3610234d9e550032603cc34762af140533e2c1de0111d3451d16eefd"
}
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Updates certain fields of a virtual device. You can only update the name, term length, status, and notification list of a virtual device.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a Virtual Device |
| 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 Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" 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 | |||
| |||
{- "core": 8,
- "notifications": [
- "test1@example.com"
], - "termLength": "1, 12, 24, 36",
- "termLengthEffectiveImmediate": false,
- "virtualDeviceName": "RCiscoSTROY",
- "clusterName": "myCluster0123",
- "status": "PROVISIONED",
- "autoRenewalOptOut": true,
- "vendorConfig": {
- "disablePassword": true
}
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Returns the reload history of a device. Please send the unique Id of the device as a path parameter.
| virtualDeviceUUID required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique ID of a virtual device. |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||
| |||||||||||
required | Array of objects (DeviceRebootResponse) Array of available reload history | ||||||||||
Array
| |||||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "deviceUUID": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "status": "SUCCESS",
- "requestedBy": "nfvsit01",
- "requestedDateTime": "2020-10-03T19:41:17Z",
- "completiondDateTime": "2020-10-03T19:41:17Z"
}
]
}Triggers the soft reboot of a device. Please send the unique Id of the device as a path parameter.
| virtualDeviceUUID required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique ID of a virtual device. |
| Location | string Example: "/ne/v1/devices/3da0a663-20d9-4b8f-8c5d-d5cf706840c8/softReboot" URL of the created RMA request. |
[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]You can use this method to change or add additional bandwidth to a virtual device.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 The unique Id of a virtual device |
Additional Bandwidth
| additionalBandwidth | integer Additional bandwidth in Mbps. |
{- "additionalBandwidth": 100
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Returns the status of the interfaces of a device. You must pass the unique Id of the device as a path parameter.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 uuid |
| id | number Interface ID. |
| name | string Interface name. |
| status | string Enum: "ASSIGNED" "AVAILABLE" "RESERVED" Interface status |
| operationStatus | string Enum: "UP" "DOWN" Interface operational status |
| macAddress | string MAC address. |
| ipAddress | string IP address. |
| assignedType | string Enum: "EQUINIX_MANAGED" "USER_MANAGED" Assigned type |
| type | string Enum: "DATA" "MGMT" "WAN" The type of interface (e.g., DATA, MGMT, WAN) |
[- {
- "id": 1,
- "name": "ethernet1",
- "status": "ASSIGNED",
- "operationStatus": "DOWN",
- "macAddress": "fa16.3e1c.a8d8",
- "ipAddress": "2.2.2.2",
- "assignedType": "EQUINIX_MANAGED",
- "type": "DATA"
}
]Pings a virtual device to ensure it's reachable. At this point, you can only ping a few SELF-CONFIGURED devices.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Virtual Device unique Id |
| message | string Ping response message. |
{- "message": "The device is reachable."
}Returns the throughput statistics of a device interface. Pass the unique Id of the device and the interface Id as path parameters.
| virtualDeviceUuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a device |
| interfaceId required | string Example: 1 Interface Id |
| startDateTime | string <date-time> Example: startDateTime=2023-11-10T19:06:06Z Start time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ) |
| endDateTime | string <date-time> Example: endDateTime=2023-11-17T19:06:06Z End time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ) |
object (InterfaceStatsDetailObject) Detailed interface statistics | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
{- "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
}
]
}
}
}Returns the upgrade history of a device. Please send the unique Id of the device as a path parameter.
| virtualDeviceUuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique ID of a virtual device. |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||||
| |||||||||||||
required | Array of objects (DeviceUpgradeDetailsResponse) Array of available upgrade history | ||||||||||||
Array
| |||||||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
- "virtualDeviceUuid": "8ed6ffcb-cef5-4801-83a3-2aa2b6c682f0",
- "status": "SUCCESS",
- "requestedDateTime": "2020-10-03T19:41:17Z",
- "completiondDateTime": "2020-10-03T19:41:17Z",
- "requestedBy": "eqxnfvuser1"
}
]
}APIs for managing device link groups and connections between virtual devices.
This method returns device links. You can link any two or more devices that are registered and provisioned.
| metro | string Example: metro=SV Metro Code |
| virtualDeviceUuid | string Example: virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device. |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 Unique Id of the account. A reseller querying for a customer's link groups can pass the accountUcmId of the customer's account. |
| groupUuid | string Example: groupUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a link group |
| groupName | string Example: groupName=linkGroup The name of a link group |
| offset | integer <int32> Default: 0 Specifies where to start a page. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||||||||||||||
| |||||||||||||||||||||||
required | Array of objects (DeviceLinkGroup) Array of available links | ||||||||||||||||||||||
Array
| |||||||||||||||||||||||
{- "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",
- "createdDateTime": "2019-09-15T10:30:31Z",
- "lastUpdatedBy": "reg2-acc1",
- "lastUpdatedDateTime": "2019-09-16T10:30:31Z",
- "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
}
]
}
]
}Call this API to create a device link between virtual devices. You can include any devices that are registered and provisioned.
New Device Link Group
| groupName required | string Group name. | ||||||||
| subnet required | string Subnet of the link group. | ||||||||
| redundancyType | string Enum: "PRIMARY" "SECONDARY" 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
| |||||||||
{- "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"
}
]
}{- "uuid": "a5d9182d-c529-451d-b137-3742d5a742ce"
}This API will return a device link by its unique Id. Authorization checks are performed on the users of this API.
| uuid required | string Example: 6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567 Unique Id of a device link group. |
| 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 Enum: "PRIMARY" "SECONDARY" Whether the connection is through Fabric's primary or secondary port. | ||||||||||||||||||||||||
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" Status of the linked group | ||||||||||||||||||||||||
| createdBy | string Created by username. | ||||||||||||||||||||||||
| createdDateTime | string <date-time> Created date. | ||||||||||||||||||||||||
| lastUpdatedBy | string Last updated by user | ||||||||||||||||||||||||
| lastUpdatedDateTime | string <date-time> Last updated date | ||||||||||||||||||||||||
Array of objects (LinkInfoResponse) An array of links between metros. | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
Array of objects (LinkDeviceResponse) An array of metros and the devices in the metros belonging to the group. | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
{- "uuid": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567",
- "groupName": "my-new-link",
- "subnet": "10.0.0.0/27",
- "redundancyType": "SECONDARY",
- "status": "PROVISIONING",
- "createdBy": "nfv-sit1",
- "createdDateTime": "2019-09-15T10:30:31Z",
- "lastUpdatedBy": "reg2-acc1",
- "lastUpdatedDateTime": "2019-09-16T10:30:31Z",
- "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
}
]
}This method deletes a device link group. Authorization checks are performed on the users of this API.
| uuid required | string Example: 6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567 Unique Id of a device link group. |
[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Call this API to update a device link. Authorization checks are performed on the users of this API.
| uuid required | string Example: 6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567 Unique Id of a device link group. |
Device Link Group
| groupName required | string Group name. | ||||||||
| subnet required | string Subnet of the link group. | ||||||||
| redundancyType | string Enum: "PRIMARY" "SECONDARY" 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
| |||||||||
{- "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"
}
]
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Returns BGP configurations on the Network Edge platform. Authorization checks are performed on the users of this API.
| virtualDeviceUuid | string Example: virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device |
| connectionUuid | string Example: connectionUuid=f79eead8-b837-41d3-9095-9b15c2c4996d Unique Id of a connection |
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" Example: status=PROVISIONED Provisioning status of BGP Peering |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 Unique Id of an account. A reseller querying for a customer's devices can input the accountUcmId of the customer's account. |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (BgpInfo) Array of available BGP configurations | ||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "authenticationKey": "pass123",
- "connectionUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "createdBy": "jsmith",
- "createdByEmail": "jsmith@example.com",
- "createdByFullName": "John Smith",
- "createdDateTime": "2023-11-10T19:32:14Z",
- "deletedBy": "jsmith",
- "deletedByEmail": "jsmith@example.com",
- "deletedByFullName": "John Smith",
- "deletedDateTime": "2023-11-10T19:32:14Z",
- "lastUpdatedBy": "jsmith",
- "lastUpdatedByEmail": "jsmith@example.com",
- "lastUpdatedByFullName": "John Smith",
- "lastUpdatedDateTime": "2023-11-10T19:32:14Z",
- "localAsn": 65001,
- "localIpAddress": "10.0.0.1/30",
- "provisioningStatus": "PROVISIONED",
- "remoteAsn": 65002,
- "remoteIpAddress": "10.0.0.2",
- "state": "ESTABLISHED",
- "uuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "virtualDeviceUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d"
}
]
}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.
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. |
{- "authenticationKey": "pass123",
- "connectionUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "localAsn": 10012,
- "localIpAddress": "100.210.1.221/30",
- "remoteAsn": 10013,
- "remoteIpAddress": "100.210.1.31"
}{- "uuid": "f79eead8-b837-41d3-9095-9b15c2c4996d"
}Gets a BGP peering configuration by its unique Id. Authorization checks are performed on the users of this API.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 uuid |
| authenticationKey | string Authentication key |
| connectionUuid | string Connection UUID |
| createdBy | string Created by user |
| createdByEmail | string Created by email |
| createdByFullName | string Created by full name |
| createdDateTime | string <date-time> Created date |
| deletedBy | string Deleted by user |
| deletedByEmail | string Deleted by email |
| deletedByFullName | string Deleted by full name |
| deletedDateTime | string <date-time> Deleted date |
| lastUpdatedBy | string Last updated by user |
| lastUpdatedByEmail | string Last updated by email |
| lastUpdatedByFullName | string Last updated by full name |
| lastUpdatedDateTime | string <date-time> Last updated date |
| localAsn | integer <int64> Local ASN |
| localIpAddress | string Local IP address |
| provisioningStatus | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" Provisioning status |
| remoteAsn | integer <int64> Remote ASN |
| remoteIpAddress | string Remote IP address |
| state | string Enum: "IDLE" "CONNECT" "ACTIVE" "OPENSENT" "OPENCONFIRM" "ESTABLISHED" State |
| uuid | string BGP configuration UUID |
| virtualDeviceUuid | string Virtual device UUID |
{- "authenticationKey": "pass123",
- "connectionUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "createdBy": "jsmith",
- "createdByEmail": "jsmith@example.com",
- "createdByFullName": "John Smith",
- "createdDateTime": "2023-11-10T19:32:14Z",
- "deletedBy": "jsmith",
- "deletedByEmail": "jsmith@example.com",
- "deletedByFullName": "John Smith",
- "deletedDateTime": "2023-11-10T19:32:14Z",
- "lastUpdatedBy": "jsmith",
- "lastUpdatedByEmail": "jsmith@example.com",
- "lastUpdatedByFullName": "John Smith",
- "lastUpdatedDateTime": "2023-11-10T19:32:14Z",
- "localAsn": 65001,
- "localIpAddress": "10.0.0.1/30",
- "provisioningStatus": "PROVISIONED",
- "remoteAsn": 65002,
- "remoteIpAddress": "10.0.0.2",
- "state": "ESTABLISHED",
- "uuid": "f79eead8-b837-41d3-9095-9b15c2c4996d",
- "virtualDeviceUuid": "f79eead8-b837-41d3-9095-9b15c2c4996d"
}Updates an existing BGP peering configuration identified by its unique Id. Authorization checks are performed on the users of this API.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 uuid |
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 |
{- "authenticationKey": "pass123",
- "localAsn": 10012,
- "localIpAddress": "100.210.1.221/30",
- "remoteAsn": 10013,
- "remoteIpAddress": "100.210.1.31"
}{- "uuid": "f79eead8-b837-41d3-9095-9b15c2c4996d"
}Gets all VPN configurations by user name and specified parameter(s). Authorization checks are performed on the users of this API.
| statusList | Array of strings Items Enum: "PROVISIONED" "PROVISIONING" "PROVISIONING_RETRYING" "UPDATING" "PROVISIONING_UPDATE_RETRYING" "DEPROVISIONED" "DEPROVISIONING" "DEPROVISIONING_RETRYING" "PROVISIONING_FAILED" "PROVISIONING_UPDATE_FAILED" "DEPROVISIONING_FAILED" Example: statusList=PROVISIONED One or more desired status |
| virtualDeviceUuid | string Example: virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (VpnResponse) Array of available VPN configurations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "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,
- "createdDateTime": "2018-05-18T06:34:26Z",
- "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",
- "lastUpdatedDateTime": "2018-07-21T05:20:20Z",
- "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"
}
]
}Creates a VPN configuration. You must have a provisioned virtual device with a registered license to create a VPN.
VPN info
| siteName required | string Name of the site | ||||||||||||||||
| virtualDeviceUuid required | string The unique Id of the primary device. | ||||||||||||||||
| configName | string Configuration name | ||||||||||||||||
| peerIp required | string Peer IP address | ||||||||||||||||
| peerSharedKey required | string Peer shared key | ||||||||||||||||
| 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) VPN request details | |||||||||||||||||
| |||||||||||||||||
{- "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"
}
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Gets a VPN configuration by its unique Id. Authorization checks are performed on the users of this API.
| uuid required | string Example: 877a3aa2-c49a-4af1-98a6-007424e737ae uuid |
| siteName required | string Site name |
| uuid | string Connection UUID |
| virtualDeviceUuid required | string Virtual device UUID |
| configName | string Configuration name |
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" VPN status |
| peerIp required | string Peer IP address |
| peerSharedKey required | string Peer shared key |
| 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 Enum: "ESTABLISHED" "IDLE" "ACTIVE" "CONNECT" "OPENSENT" "OPENCONFIRM" BGP state |
| inboundBytes | string Inbound bytes |
| inboundPackets | string Inbound packets |
| outboundBytes | string Outbound bytes |
| outboundPackets | string Outbound packets |
| tunnelStatus | string Enum: "UP" "DOWN" Tunnel status |
| custOrgId | integer <int64> Customer organization ID |
| createdDateTime | string <date-time> Created date |
| createdByFirstName | string Created by first name |
| createdByLastName | string Created by last name |
| createdByEmail | string Created by email |
| createdByUserKey | integer <int64> Created by user key |
| createdByAccountUcmId | integer <int64> Created by account UCM ID |
| createdByUserName | string Created by username |
| createdByCustOrgId | integer <int64> Created by customer organization ID |
| createdByCustOrgName | string Created by customer organization name |
| createdByUserStatus | string Enum: "ACTIVATED" "DEACTIVATED" "PENDING" User status |
| createdByCompanyName | string Created by company name |
| lastUpdatedDateTime | string <date-time> Last updated date |
| updatedByFirstName | string Updated by first name |
| updatedByLastName | string Updated by last name |
| updatedByEmail | string Updated by email |
| updatedByUserKey | integer <int64> Updated by user key |
| updatedByAccountUcmId | integer <int64> Updated by account UCM ID |
| updatedByUserName | string Updated by username |
| updatedByCustOrgId | integer <int64> Updated by customer organization ID |
| updatedByCustOrgName | string Updated by customer organization name |
| updatedByUserStatus | string Enum: "ACTIVATED" "DEACTIVATED" "PENDING" User status |
| updatedByCompanyName | string Updated by company name |
{- "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,
- "createdDateTime": "2018-05-18T06:34:26Z",
- "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",
- "lastUpdatedDateTime": "2018-07-21T05:20:20Z",
- "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 a VPN configuration by its unique Id. Authorization checks are performed on the users of this API.
| uuid required | string Example: 877a3aa2-c49a-4af1-98a6-007424e737ae uuid |
VPN info
| siteName required | string Name of the site | ||||||||||||||||
| virtualDeviceUuid required | string The unique Id of the primary device. | ||||||||||||||||
| configName | string Configuration name | ||||||||||||||||
| peerIp required | string Peer IP address | ||||||||||||||||
| peerSharedKey required | string Peer shared key | ||||||||||||||||
| 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) VPN request details | |||||||||||||||||
| |||||||||||||||||
| siteName required | string Site name |
| uuid | string Connection UUID |
| virtualDeviceUuid required | string Virtual device UUID |
| configName | string Configuration name |
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" VPN status |
| peerIp required | string Peer IP address |
| peerSharedKey required | string Peer shared key |
| 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 Enum: "ESTABLISHED" "IDLE" "ACTIVE" "CONNECT" "OPENSENT" "OPENCONFIRM" BGP state |
| inboundBytes | string Inbound bytes |
| inboundPackets | string Inbound packets |
| outboundBytes | string Outbound bytes |
| outboundPackets | string Outbound packets |
| tunnelStatus | string Enum: "UP" "DOWN" Tunnel status |
| custOrgId | integer <int64> Customer organization ID |
| createdDateTime | string <date-time> Created date |
| createdByFirstName | string Created by first name |
| createdByLastName | string Created by last name |
| createdByEmail | string Created by email |
| createdByUserKey | integer <int64> Created by user key |
| createdByAccountUcmId | integer <int64> Created by account UCM ID |
| createdByUserName | string Created by username |
| createdByCustOrgId | integer <int64> Created by customer organization ID |
| createdByCustOrgName | string Created by customer organization name |
| createdByUserStatus | string Enum: "ACTIVATED" "DEACTIVATED" "PENDING" User status |
| createdByCompanyName | string Created by company name |
| lastUpdatedDateTime | string <date-time> Last updated date |
| updatedByFirstName | string Updated by first name |
| updatedByLastName | string Updated by last name |
| updatedByEmail | string Updated by email |
| updatedByUserKey | integer <int64> Updated by user key |
| updatedByAccountUcmId | integer <int64> Updated by account UCM ID |
| updatedByUserName | string Updated by username |
| updatedByCustOrgId | integer <int64> Updated by customer organization ID |
| updatedByCustOrgName | string Updated by customer organization name |
| updatedByUserStatus | string Enum: "ACTIVATED" "DEACTIVATED" "PENDING" User status |
| updatedByCompanyName | string Updated by company name |
{- "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"
}
}{- "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,
- "createdDateTime": "2018-05-18T06:34:26Z",
- "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",
- "lastUpdatedDateTime": "2018-07-21T05:20:20Z",
- "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"
}Deletes a VPN configuration by its unique Id. Authorization checks are performed on the users of this API.
| uuid required | string Example: 877a3aa2-c49a-4af1-98a6-007424e737ae uuid |
| siteName required | string Site name |
| uuid | string Connection UUID |
| virtualDeviceUuid required | string Virtual device UUID |
| configName | string Configuration name |
| status | string Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONED" "DEPROVISIONING" "FAILED" VPN status |
| peerIp required | string Peer IP address |
| peerSharedKey required | string Peer shared key |
| 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 Enum: "ESTABLISHED" "IDLE" "ACTIVE" "CONNECT" "OPENSENT" "OPENCONFIRM" BGP state |
| inboundBytes | string Inbound bytes |
| inboundPackets | string Inbound packets |
| outboundBytes | string Outbound bytes |
| outboundPackets | string Outbound packets |
| tunnelStatus | string Enum: "UP" "DOWN" Tunnel status |
| custOrgId | integer <int64> Customer organization ID |
| createdDateTime | string <date-time> Created date |
| createdByFirstName | string Created by first name |
| createdByLastName | string Created by last name |
| createdByEmail | string Created by email |
| createdByUserKey | integer <int64> Created by user key |
| createdByAccountUcmId | integer <int64> Created by account UCM ID |
| createdByUserName | string Created by username |
| createdByCustOrgId | integer <int64> Created by customer organization ID |
| createdByCustOrgName | string Created by customer organization name |
| createdByUserStatus | string Enum: "ACTIVATED" "DEACTIVATED" "PENDING" User status |
| createdByCompanyName | string Created by company name |
| lastUpdatedDateTime | string <date-time> Last updated date |
| updatedByFirstName | string Updated by first name |
| updatedByLastName | string Updated by last name |
| updatedByEmail | string Updated by email |
| updatedByUserKey | integer <int64> Updated by user key |
| updatedByAccountUcmId | integer <int64> Updated by account UCM ID |
| updatedByUserName | string Updated by username |
| updatedByCustOrgId | integer <int64> Updated by customer organization ID |
| updatedByCustOrgName | string Updated by customer organization name |
| updatedByUserStatus | string Enum: "ACTIVATED" "DEACTIVATED" "PENDING" User status |
| updatedByCompanyName | string Updated by company name |
{- "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,
- "createdDateTime": "2018-05-18T06:34:26Z",
- "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",
- "lastUpdatedDateTime": "2018-07-21T05:20:20Z",
- "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"
}Returns the backups of a virtual device. Authorization checks are performed on the users of this API.
| virtualDeviceUuid | string Example: virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique ID of a virtual device |
| status | string Enum: "COMPLETED" "FAILED" "IN_PROGRESS" Example: status=COMPLETED An array of status values |
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
required | object (PaginationResponse) | ||||||||||||||||||||||
| |||||||||||||||||||||||
required | Array of objects (DeviceBackupInfoVerbose) Array of available backups | ||||||||||||||||||||||
Array
| |||||||||||||||||||||||
{- "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",
- "lastUpdatedDateTime": "2018-01-30T10:30:31Z",
- "downloadUrl": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download",
- "deleteAllowed": true,
- "restores": [
- {
- "uuid": "7hgj5675-5c3f-4275-adba-0c9e3c26c45y",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "createdDateTime": "2018-01-30T10:30:31Z",
- "lastUpdatedDateTime": "2018-01-30T10:30:31Z"
}
], - "deviceUuid": "78fb5675-5c3f-4275-adba-0c9e3c26c78c"
}
]
}Creates the backup of a virtual device. Authorization checks are performed on the users of this API.
Device backup info
| deviceUuid required | string The unique Id of a virtual device. |
| name required | string The name of backup. |
{- "deviceUuid": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8",
- "name": "My New Backup"
}{- "uuid": "12828472-e6e9-4f2b-98f7-b79cf0fab4ff"
}Returns the details of a backup by its unique ID. Authorization checks are performed on the users of this API.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique ID of a backup |
| uuid | string The unique Id of the device backup. | ||||||||||
| name | string The name of the backup. | ||||||||||
| version | string Version of the device | ||||||||||
| type | string Value: "CONFIG" The type of backup. | ||||||||||
| status | string Enum: "COMPLETED" "FAILED" "IN_PROGRESS" The status of the backup. | ||||||||||
| createdBy | string Created by. | ||||||||||
| lastUpdatedDateTime | string <date-time> 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 | ||||||||||
{- "uuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "name": "My New Backup",
- "version": "16.09.02",
- "type": "CONFIG",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "lastUpdatedDateTime": "2018-01-30T10:30:31Z",
- "downloadUrl": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download",
- "deleteAllowed": true,
- "restores": [
- {
- "uuid": "7hgj5675-5c3f-4275-adba-0c9e3c26c45y",
- "status": "COMPLETED",
- "createdBy": "cust0001",
- "createdDateTime": "2018-01-30T10:30:31Z",
- "lastUpdatedDateTime": "2018-01-30T10:30:31Z"
}
], - "deviceUuid": "78fb5675-5c3f-4275-adba-0c9e3c26c78c"
}Deletes a backup by its unique ID. Authorization checks are performed on users of this API.
| uuid required | string Example: 4cfb5675-5c3f-4275-adba-0c9e3c26c96b Unique Id a backup |
[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Updates the name of a backup. Authorization checks are performed on users of this API.
| uuid required | string Example: 4cfb5675-5c3f-4275-adba-0c9e3c26c96b Unique ID of a backup |
Update device backup
| name required | string The name of backup. |
{- "name": "My New Backup"
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Downloads the backup of a device by its backup ID. Authorization checks are performed on the users of this API.
| uuid required | string Example: 4cfb5675-5c3f-4275-adba-0c9e3c26c96b Unique ID of a backup |
The configuration of the device in a string format.
"Current configuration 9531 bytes"Checks the feasibility of restoring the backup of a virtual device. Authorization checks are performed on the users of this API.
| uuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique ID of a device |
| backupUuid | string Example: backupUuid=4cfb5675-5c3f-4275-adba-0c9e3c26c96b Unique ID of a backup |
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. | ||||||||||||
{- "deviceBackup": {
- "deviceBackup": {
- "uuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "name": "My New Backup",
- "status": "COMPLETED",
- "deleteAllowed": true
}
}, - "services": {
- "serviceName": {
- "serviceId": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
- "serviceName": "L2 Connection with AWS",
- "operationNeededToPerform": "DELETE"
}
}, - "restoreAllowedAfterDeleteOrEdit": false
}Restores any backup of a device. Authorization checks are performed on users of this API.
| uuid required | string Example: 4cfb5675-5c3f-4275-adba-0c9e3c26c96b Unique ID of a backup |
Update device backup
| name required | string The name of backup. |
{- "name": "My New Backup"
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Returns the downloadable images of a device type. Pass any device type as a path parameter to get the list of downloadable images.
| deviceType required | string Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Example: C8000V Device type |
| uuid | string The unique Id of the downloadable link. |
| deviceType | string Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Device type code (e.g., C8000V) |
| imageName | string Name of the image. |
| version | string Device version |
[- {
- "uuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
- "deviceType": "C8000V",
- "imageName": "CiscoSyst-C8000VCon-17.11.01a-3270",
- "version": "17.11.01a"
}
]Returns a link to download image. You need to provide a device type and version as path parameters.
| deviceType required | string Enum: "C8000V" "CSR1000V" "PA_VM" "ASAV" "ISR1100" "SRX_V" "VSRX" "FORTIGATE_VM" "EDGE" Example: C8000V Device type |
| version required | string Example: 17.06.01 Version |
{
}Returns all ACL templates. The ACL templates list the networks that require access to the device.
| offset | integer <int32> Default: 0 Specifies where to start a page. It is the starting point of the collection returned from the server. |
| limit | integer <int32> Default: 20 Example: limit=20 Specifies the page size. |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 Unique ID of the account. A reseller querying for the ACLs of a customer should input the accountUcmId of the customer. |
required | object (PaginationResponse) | ||||||||||||||
| |||||||||||||||
required | Array of objects (DeviceACLDetailsResponse) Array of available ACL templates | ||||||||||||||
Array
| |||||||||||||||
{- "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",
- "createdDateTime": "2020-10-03T19:41:17Z",
- "status": "DEVICE_NOT_READY"
}
]
}Creates ACL templates. You can find the unique ID of the ACL template in the location header.
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 A reseller creating an ACL template for a customer can pass the accountUcmId of the customer. |
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
| |||||||||||||
| uuid | string Unique ID of the created virtual device |
{- "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"
}
]
}{- "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae"
}Returns details of any existing template. You must provide the unique ID of an existing template as a path parameter.
| uuid required | string Example: be7ef79e-31e7-4769-be5b-e192496f48aa Unique Id of an ACL template |
| 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 | ||||||||||||
| createdDateTime | string <date-time> Created date | ||||||||||||
{- "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",
- "createdDateTime": "2020-10-03T19:41:17Z"
}Updates an ACL template. You must pass the unique Id of the ACL template as a path parameter.
| uuid required | string Example: be7ef79e-31e7-4769-be5b-e192496f48aa Unique ID of an ACL template |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 A reseller updating an ACL template for a customer must pass the accountUcmId of the customer. |
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
| |||||||||||||
{- "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"
}
]
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]Deletes an ACL template. You must provide the unique Id of the ACL template as a path parameter.
| uuid required | string Example: be7ef79e-31e7-4769-be5b-e192496f48aa Unique ID of an ACL template |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 A reseller deleting an ACL template for a customer must pass the accountUcmId of the customer. |
[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]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.
| virtualDeviceUuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device. |
object (DeviceACLDetailsResponse) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (DeviceACLDetailsResponse) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
{- "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",
- "createdDateTime": "2020-10-03T19:41:17Z",
- "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",
- "createdDateTime": "2020-10-03T19:41:17Z",
- "status": "DEVICE_NOT_READY"
}
}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.
| virtualDeviceUuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device. |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer. |
Update the ACL of a device.
required | Array of objects (ACLDetails) An array of ACLs. | ||||
Array
| |||||
{- "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
]
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]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.
| virtualDeviceUuid required | string Example: 3da0a663-20d9-4b8f-8c5d-d5cf706840c8 Unique Id of a virtual device. |
| accountUcmId | string Example: accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649 A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer. |
Update the ACL of a device.
required | Array of objects (ACLDetails) An array of ACLs. | ||||
Array
| |||||
{- "aclDetails": [
- {
- "interfaceType": "WAN",
- "uuid": "ce7ef79e-31e7-4769-be5b-e192496f48ab"
}
]
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]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.
| virtualDeviceUuid required | string Example: 877a3aa2-c49a-4af1-98a6-007424e737ae Unique ID of a device |
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) RMA vendor configuration | |||||||||||||||||||||
| |||||||||||||||||||||
object (UserPublicKeyRequest) An object with public key details. | |||||||||||||||||||||
| |||||||||||||||||||||
{- "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"
}
}[- {
- "errorCode": "EQ-4001530",
- "errorMessage": "Invalid input.",
- "additionalInfo": [
- {
- "key": "Error Key",
- "value": "Error description"
}
], - "details": "field_name",
- "help": "field is incorrect",
- "correlationId": "xyz-abc-123"
}
]