Virtual Device

Get Virtual Devices

GET /ne/v1/devices
Method GET
URL or End Point /ne/v1/devices
Headers Authorization, Content-Type
Query Parameters offset, limit, metroCode, status, accountUcmId, sort, searchText
Body Not applicable

Returns the details of virtual devices.

To retrieve drafts, query with the status "DRAFT."

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

Sample curl request:

Copy 
curl -X
GET "https://api.equinix.com/ne/v1/devices?offset=0&limit=20&metroCode=DC&status=PROVISIONED"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
offset No integer 0 Specifies where to start a page. It is the starting point of the collection returned from the server.
limit No integer 100 Specifies the page size.
metroCode No string DC Metro for which you want virtual devices.
status No string INITIALIZING INITIALIZING, PENDING_ACCOUNT, PROVISIONING, WAITING_FOR_PRIMARY, WAITING_FOR_SECONDARY, WAITING_FOR_REPLICA_CLUSTER_NODES, CLUSTER_SETUP_IN_PROGRESS, CLUSTER_SETUP_FAILED, PROVISIONED, FAILED, DEPROVISIONING, DEPROVISIONED, DRAFT The status of the virtual device.
accountUcmId No string 678907 Unique Id of the account. A reseller querying for a customer's devices can input the accountUcmId of the customer's account. To find out the accountUcmId of your customer's account, please check the Equinix account creation portal (ECP) or call Get account API.
searchText No string myDevice Search with a partial string to find matching device names.
sort No string sort=sortKey1, -sortKey2, sortKey3 Sorts the output by certain names. You can sort by name, status, metro, createdDate, lastUpdatedDate, vendor (sorts by deviceTypeVendor), and type (sorts by deviceTypeCategory). Add the prefix "-" to sort in descending order.

Sample response:

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1,
        "next": "/nfv/v1/devices?status=PROVISIONED&offset=20&limit=20"
    },
    "data": [
        
     {
        "uuid": "76e33e9e-6155-472e-ae76-37b5401f888f",
        "serviceId": "31794-1667500136461-vd",
        "name": "Gnasit_csr8K_170901a_DEC_pod17",
        "deviceTypeCode": "C8000V",
        "deviceTypeName": "8000V (Autonomous Mode)",
        "deviceTypeVendor": "Cisco",
        "deviceTypeCategory": "ROUTER",
        "status": "PROVISIONED",
        "licenseStatus": "APPLIED",
        "metroCode": "SY",
        "metroName": "Sydney",
        "podName": "GEN2",
        "ibx": "SY4",
        "region": "APAC",
        "hostName": "myhost-2",
        "packageCode": "network-advantage",
        "packageName": "DNA Advantage",
        "version": "17.09.01a",
        "licenseType": "BYOL",
        "licenseName": "Bring Your Own License",
        "createdBy": "eqxnfvuser1",
        "createdDate": "2022-11-03T18:28:56.465Z",
        "lastUpdatedBy": "eqxnfvuser1",
        "lastUpdatedDate": "2022-11-03T18:30:31.999Z",
        "aclTemplateUuid": "dbdcb672-e37d-4072-85e2-19c4d0eaf5ef",
        "sshIpAddress": "173.205.198.156",
        "sshIpFqdn": "myhost-2-156-198-205-173-SY.nfvhost.equinix.com",
        "sshIpFqdnStatus": "ASSIGNED",
        "accountNumber": "201098",
        "accountName": "eqx-nfv-201098",
        "notifications": [
            "schilkuri@equinix.com"
        ],
        "redundancyType": "PRIMARY",
        "connectivity": "INTERNET-ACCESS",
        "managementIp": "10.80.35.62/24",
        "managementGatewayIp": "10.80.35.1",
        "publicIp": "173.205.198.156/29",
        "publicGatewayIp": "173.205.198.153",
        "primaryDnsName": "8.8.8.8",
        "secondaryDnsName": "8.8.4.4",
        "termLength": 1,
        "newTermLength": 12,
        "billingCommencementDate": "12/11/2022 18:30:13",
        "billingEnabled": true,
        "additionalBandwidth": 0,
        "vendorConfig": {
            "adminPassword": "5NYsj6qv7y"
        },
        "orderingContact": {
            "username": "eqxnfvuser1"
        },
        "interfaceCount": 10,
        "core": {
            "core": 2,
            "memory": 4,
            "unit": "GB",
            "tier": 2
        },
        "deviceManagementType": "SELF-CONFIGURED",
        "userPublicKey": {
            "username": "csrktestify2022_123",
            "publicKeyName": "situser",
            "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDtd7Vdo6+kjz80JJyc80R6mMrD/rOc9i5wpiAxS1BvBeoQx/RWzpba2W6h3Q9dP9n+VhrTGK3hNpZafrCIdmmQjTYUS0GvKnW4lo4B+rPGxpJvJTzvRqWYWn0eo2wzCjixIZ6xY6+JEBKdNgOnHy9BHqSf9JH9j4joJ1otWpLu4VQRYVstThruNPPlePpn80DTPra9uR7DRjyBKsFdY64m+eblz8XKFkKC0EkyaVmKpILilkezZRbo9C4rky9QrKk/wKnsSGpzblIsbMYiGRqyXW+Q4QtY5vRARXvwMHhk7XijWmdTJ7EEc2eN3FwLsM/euqcFT4c10TA/QTNbg2B9 situser@spirent-centos",
            "publicKeyType": "RSA"
        },
        "networkScope": "TENANT",
        "plane": "PRIMARY",
        "interfaces": [
          {
            "id": 1,
            "name": "GigabitEthernet1",
            "macAddress": null,
            "status": null,
            "type": "MGMT",
            "ipAddress": null,
            "vxLan": null,
            "assignedType": "Equinix Managed"
          },
          {
            "id": 2,
            "name": "GigabitEthernet2",
            "macAddress": null,
            "status": null,
            "type": "SSH",
            "ipAddress": null,
            "vxLan": 6640,
            "assignedType": "Equinix Managed"
          },
          {
            "id": 3,
            "name": "GigabitEthernet3",
            "macAddress": "fa:16:3e:c1:b5:ad",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9556,
            "assignedType": ""
          },
          {
            "id": 4,
            "name": "GigabitEthernet4",
            "macAddress": "fa:16:3e:b6:69:72",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9557,
            "assignedType": ""
          },
          {
            "id": 5,
            "name": "GigabitEthernet5",
            "macAddress": "fa:16:3e:b0:86:ba",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9558,
            "assignedType": ""
          },
          {
            "id": 6,
            "name": "GigabitEthernet6",
            "macAddress": "fa:16:3e:06:07:3e",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9559,
            "assignedType": ""
          },
          {
            "id": 7,
            "name": "GigabitEthernet7",
            "macAddress": "fa:16:3e:73:b3:62",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9560,
            "assignedType": ""
          },
          {
            "id": 8,
            "name": "GigabitEthernet8",
            "macAddress": "fa:16:3e:c0:db:da",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9561,
            "assignedType": ""
          },
          {
            "id": 9,
            "name": "GigabitEthernet9",
            "macAddress": "fa:16:3e:1d:24:fb",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9562,
            "assignedType": ""
          },
          {
            "id": 10,
            "name": "GigabitEthernet10",
            "macAddress": "fa:16:3e:bb:46:b4",
            "status": "AVAILABLE",
            "type": "DATA",
            "ipAddress": null,
            "vxLan": 9563,
            "assignedType": ""
          }
        ]
      }
    ]
}

The description of the response:

Field Name Type Example Values Description
pagination object An object that has pagination information.
offset integer 0 It is the starting point of the collection returned from the server.
limit integer 20 The page size.
total integer 100 The total number of results.
data array An array of virtual device objects.
uuid string ec68e425-f973-452e-a866-76be5844d0ba The unique Id of the virtual device (uuid).
name string Test-device-003-SROY The name of the virtual device.
deviceTypeCode string C8000V Device type code.
deviceTypeName string C8000V Device type name.
deviceTypeVendor string Cisco The vendor of the device.
deviceTypeCategory string ROUTER The category of the device.
diverseFromDeviceName string My-Other-Device The name of a device that is in a location different from this device.
diverseFromDeviceUuid string 4cfb5675-5c3f-4275-adba-0c9e3c26c96b The unique Id of a device that is in a location different from this device.
status string PROVISIONED The status of the device.
licenseStatus string REGISTERED The status of the license.
expiry string Never License expiry.
metroCode string DC The metro where the device is located.
metroName string Ashburn The name of the metro.
ibx string DC1 Name of Equinix exchange. One metro may have several exchanges.
region string AMER The region in which the metro is located
throughput integer 500 Throughput of the device
throughputUnit string Mbps Throughput unit.
hostName string TC12 Host name.
packageCode string SEC Software package code.
packageName string Security Software package name.
version string 16.09.02 The version of the software.
licenseType string BYOL The type of license. As of now, we only offer BYOL.
licenseName string Bring Your Own License The name of the license.
licenseFileld string 9125e24a-708b-4c6e-8694-2c3ca727b081 The license file Id. You get a licenseFileId when you upload the license file from your vendor to the Equinix platform.
createdBy string myna Created by.
createdDate string 2019-05-03T03:11:44.127Z Creation date.
deletedBy string myna Deleted by.
deletedDate string 2019-05-03T03:11:44.127Z Deletion date.
lastUpdatedBy string myna Last updated by.
lastUpdatedDate string 2019-05-03T03:11:44.127Z Last update date.
sshIpAddress string 64.191.210.44 SshIpAddress of the device.
deviceSerialNo string 92CONAW32JC The serial number of the device.
sshIpFqdn string myhost-2-44-210-191-64-DC.nfv-uat1.eis.lab.equinix.com The fully qualified domain name of the device.
sshIpFqdnStatus string ASSIGNED sshIpFqdnStatus. Possible values:
  • ASSIGNED: DNS assigned successfully
  • UNASSIGNED: We are in the process of assigning DNS
  • RELEASED: The DNS is released
accountNumber string 2252619 Account number.
accountName string nfv-sit1 Account name.
notifications array[] test@equinix.com The list of email addresses that will receive device life-cycle notifications.
purchaseOrderNumber string 3456778 Customer's purchase order number.
redundancyType string PRIMARY Whether this device is primary or secondary. Secondary devices are redundant devices that ensure high availability. For cluster devices, the redundancy type is CLUSTER.
redundantUuid string 086d0425-69b7-4c8e-8a29-a3d5a1e543da Unique Id of the redundant device. If this device is primary, then this field will have the unique Id of the secondary device. Otherwise, if this device is a secondary device, then this will field will have the unique Id of the primary device.
connectivity string INTERNET-ACCESS Specifies the connectivity on the device. Possible values:
  • INTERNET-ACCESS
  • PRIVATE: A private device will not have ACLs or bandwidth.
  • INTERNET-ACCESS-WITH-PRVT-MGMT
.
managementIp string 10.198.251.54/24 Management IP. This optional parameter is relevant for SD-WAN devices.
managementGatewayIp string 10.198.251.1 Management Gateway IP. This optional parameter is relevant for SD-WAN devices.
publicIp string 149.97.198.97/31 Public IP. This optional parameter is relevant for SD-WAN devices.
publicGatewayIp string 149.97.198.96 Public Gateway IP. This optional parameter is relevant for SD-WAN devices.
primaryDnsName string 4.0.0.53 Primary DNS name. This optional parameter is relevant for SD-WAN devices.
secondaryDnsName string 129.250.35.250 Secondary DNS name. This optional parameter is relevant for SD-WAN devices.
billingCommencementDate string 09/07/2020 21:16:49 Billing commencement date.
additionalBandwidth integer 100 Additional bandwidth in Mbps.
pricingDetails object An object that has the pricing details of a quote created for Network Edge on Siebel.
termLength string 12 The length of the contract.
newTermLength string 24 The future term length effective upon completion of the current term.
orderNumber string 1-198735018693 The order number of a quote created for Network Edge on Siebel.
core integer 4 The number of cores on a quote created for Network Edge on Siebel.
throughput integer 1 The throughput on a quote created for Network Edge on Siebel.
throughputUnit string Gbps The throughput unit on a quote created for Network Edge on Siebel.
packageCode string AX The software package on a quote created for Network Edge on Siebel.
additionalBandwidth string 100 The additional bandwidth on a quote created for Network Edge on Siebel.
primary object An object with the pricing details of the primary device.
charges array An array with the charges.
description string VIRTUAL_DEVICE The description of the price.
monthlyRecurringCharges string 200 The monthly recurring charges.
currency string USD The currency of the price.
channelPartner string SDCI The name of the channel partner.
secondary object An object with the pricing details of the secondary device.
interfaceCount integer 24 The total number of interfaces.
core object An object with the details of the core.
core.core integer 2 The number of cores.
core.memory integer 4 The amount of memory.
core.unit string GB The unit of memory.
core.tier integer 2 Tier is only relevant for Cisco 8000v devices.
deviceManagementType string SELF-CONFIGURED Whether the device is SELF-CONFIGURED or not.
licenseKey string 1404-991d81bb-2567-43e5-a14c-1493ace58046 License key (ION key). Relevant only for CloudGenix devices.
licenseSecret string d29dceeef2d2b494c9eb76937a361890786e609d License secret (Secret key). Relevant only for CloudGenix devices.
localId string SDWAN-Branch@Versa.com Email address of the branch location. Relevant only for Versa SD-WAN devices.
remoteId string Controller-01-staging@Versa.com Email address of the controller side. Relevant only for Versa SD-WAN devices.
controller1 string 54.219.248.29 Ip address of the SD-WAN controller1. Relevant only for Versa SD-WAN devices.
controller2 string 54.177.220.115 Ip address of the SD-WAN controller2. Relevant only for Versa SD-WAN devices.
userPublicKey object An object that has the SSH public key details. Relevant only for self-configured devices.
username string test-user1 The SSH username. Relevant only for self-configured devices.
publicKeyName string test-pk-2 The SSH publicKeyName. Relevant only for self-configured devices.
publicKey string ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\n The SSH publicKey. Relevant only for self-configured devices.
publicKeyType string RSA The SSH publicKeyType, whether RSA or DSA.
clusterDetails object An object that has the cluster details. This field is only relevant for cluster devices.
clusterId string 34b7838c-ec82-4166-ac19-efa03b4e34fe The Id of the cluster. This field is only relevant for cluster devices.
clusterName string myClusterDevice The name of the cluster device. This field is only relevant for cluster devices.
numOfNodes integer 2 The number of nodes in the cluster. This field is only relevant for cluster devices.
nodes array[objects] An array of the two node objects
name string myClusterDevice-Node0 The name of the node. This field is only relevant for cluster devices.
uuid string 34b7838c-ec82-4166-ac19-efa03b4e34fe The unique Id of the node. This field is only relevant for cluster devices.
node integer 0 The sequence number of the node. This field is only relevant for cluster devices.
vendorConfig object An object that has fields relevant to the vendor of the device.
vendorConfig.adminPassword string ZQelDI7sUd The administrative password of the device. You can use it to log in to the console. This field is not available for all device types.
vendorConfig.siteId string 567 Site Id. Relevant only for Cisco SD-WAN devices. A siteId is a particular physical location within the Viptela overlay network, such as a branch office, or a campus.
vendorConfig.systemIpAddress string 2.2.2.2 System IP address. Relevant only for Cisco SD-WAN devices. Each CSRSDWAN router and vSmart controller is assigned a system IP address.
vendorConfig.connectToCloudVision boolean true Only relevant for Arista devices. A "true" value means your Arista device is connected to Cloud Vision.
vendorConfig.cvpType string As-a-Service or On-Premise Only relevant for Arista devices.
vendorConfig.cvpFqdn string www.NetworkSolutions.com Fully qualified domain name for Cloud Vision As-a-Service. Only relevant for Arista devices.
vendorConfig.cvpIpAddress string 192.168.0.10 Only relevant for Arista devices. Cloud Vision Portal's IP address.
vendorConfig.cvaasPort string 443 Cvaas Port number. Only relevant for Arista devices.
vendorConfig.cvpPort string 443 Cloud Vision Portal's port number. Only relevant for Arista devices.
vendorConfig.cvpToken string 123 Cloud Vision Portal's token. Only relevant for Arista devices.
vendorConfig.privateAddress string 192.168.20.32 Private address. Relevant for BlueCat devices.
vendorConfig.privateCidrMask string 24 Private CIDR Mask. Relevant for BlueCat devices.
vendorConfig.privateGateway string 192.168.20.1 Private gateway. Relevant for BlueCat devices.
vendorConfig.licenseId string 000000123457777 License Id. Relevant for BlueCat devices.
vendorConfig.panoramaIpAddress string 1.1.1.1 IP address of the Panorama controller for Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access
vendorConfig.panoramaAuthKey string 123456 Supports secure onboarding of Palo Alto firewall devices (Panorama integration). Relevant for Palo Alto Self-Configured devices with Internet Access.
serialNumber string 4545454 The customer selects a serial number when setting up the device template on Versa director. Relevant only for Versa SD-WAN devices.
plane string PRIMARY Compute plane. This field indicates whether the device is PRIMARY or SECONDARY.
interfaces array[object] An array of interface objects.
id integer 1 The Id of the interface.
name string GigabitEthernet1 The name of the interface.
status string AVAILABLE Status of the interface, whether it is AVAILABLE, RESERVED, or ASSIGNED. Assigned interfaces are already in use. Reserved interfaces can only be used to bring your own connection (BYOC) from your Network Service Providers.
operationStatus string down The operation status of the interface, whether it is up or not.
macAddress string fa16.3e1c.a8d8 Media access control address. It is the hardware identification number that uniquely identifies each device on a network.
ipAddress string 2.2.2.2 Ip address.
assignedType string Equinix Managed Equinix-managed interfaces are not available to create connections.
type string MGMT The type of interface.
asn integer 1029 Global ASN of the device.

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

Get Virtual Device {uuid}

GET /ne/v1/devices/{uuid}
Method GET
URL or End Point /ne/v1/devices/{uuid}
Headers Authorization, Content-Type
Path Parameter uuid
Body Not applicable

Returns the details of a virtual device by its unique Id.

To retrieve a draft, provide the unique Id of the draft (draftUuid).

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

Sample curl request:

Copy 
curl -X
GET "https://api.equinix.com/ne/v1/devices/01425e3b-0e37-4539-af09-5b26cb9bad18"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string ec68e425-f973-452e-a866-76be5844d0ba Unique ID of the virtual device. To retrieve a draft, provide the unique Id of the draft (draftUuid).

Sample response:

Copy 
{
    "uuid": "f7cb93ac-df6d-4df4-92c2-557d36664341",
    "name": "Test_device#2",
    "deviceTypeCode": "C8000V",
    "deviceTypeName": "C8000V (Autonomous Mode)",
    "deviceTypeVendor": "Cisco",
    "deviceTypeCategory": "ROUTER",
    "status": "PROVISIONED",
    "licenseStatus": "REGISTERED",
    "metroCode": "DC",
    "metroName": "Ashburn",
    "ibx": "DC11",
    "region": "AMER",
    "throughput": "500",
    "throughputUnit": "Mbps",
    "hostName": "TestDevice",
    "packageCode": "APPX",
    "packageName": "AppX",
    "version": "16.09.03",
    "licenseType": "BYOL",
    "licenseName": "Bring Your Own License",
    "createdBy": "nfvsit01",
    "createdDate": "2020-09-08T17:30:12.392Z",
    "lastUpdatedBy": "nfvsit01",
    "lastUpdatedDate": "2020-09-08T17:41:19.005Z",
    "sshIpAddress": "64.191.210.254",
    "deviceSerialNo": "9U8K0JYXT6W",
    "sshIpFqdn": "TestDevice-254-210-191-64-DC.nfv-uat1.eis.lab.equinix.com",
    "sshIpFqdnStatus": "ASSIGNED",
    "accountNumber": "200541",
    "accountName": "nfv-sit1",
    "notifications": [
        "test@test.com"
    ],
    "deviceOrderNumber": "1-198877551881",
    "redundancyType": "PRIMARY",
    "connectivity": "INTERNET-ACCESS",
    "termLength": 1,
    "newTermLength": 12,
    "billingCommencementDate": "09/22/2020 17:31:14",
    "additionalBandwidth": 0,
    "orderingContact": {
        "username": "nfvsit01",
        "email": "kkolla@equinix.com",
        "firstName": "nfvsit01",
        "lastName": "nfvsit01"
    },
    "interfaceCount": 10,
    "core": {
        "core": 2,
        "memory": 4,
        "unit": "GB",
        "tier": 2
    },
    "deviceManagementType": "SELF-CONFIGURED",
    "userPublicKey": {
        "username": "csrktestify2022_123",
        "publicKeyName": "situser",
        "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDtd7Vdo6+kjz80JJyc80R6mMrD/rOc9i5wpiAxS1BvBeoQx/RWzpba2W6h3Q9dP9n+VhrTGK3hNpZafrCIdmmQjTYUS0GvKnW4lo4B+rPGxpJvJTzvRqWYWn0eo2wzCjixIZ6xY6+JEBKdNgOnHy9BHqSf9JH9j4joJ1otWpLu4VQRYVstThruNPPlePpn80DTPra9uR7DRjyBKsFdY64m+eblz8XKFkKC0EkyaVmKpILilkezZRbo9C4rky9QrKk/wKnsSGpzblIsbMYiGRqyXW+Q4QtY5vRARXvwMHhk7XijWmdTJ7EEc2eN3FwLsM/euqcFT4c10TA/QTNbg2B9 situser@spirent-centos",
        "publicKeyType": "RSA"
        },
    "networkScope": "DEVICE",
    "channelPartner": "SDCI",
    "plane": "PRIMARY",
    "interfaces": [
        {
            "id": 1,
            "name": "GigabitEthernet1",
            "status": null,
            "operationalStatus": null,
            "macAddress": null,
            "ipAddress": null,
            "assignedType": "Equinix Managed",
            "type": "MGMT"
        },
        {
            "id": 2,
            "name": "GigabitEthernet2",
            "status": null,
            "operationalStatus": null,
            "macAddress": null,
            "ipAddress": null,
            "assignedType": "Equinix Managed",
            "type": "SSH"
        },
        {
            "id": 3,
            "name": "GigabitEthernet3",
            "status": "RESERVED",
            "operationalStatus": "down",
            "macAddress": "fa16.3ec5.ae7e",
            "ipAddress": null,
            "assignedType": "Connection to Network Service Provider",
            "type": "DATA"
        },
        {
            "id": 4,
            "name": "GigabitEthernet4",
            "status": "AVAILABLE",
            "operationalStatus": "down",
            "macAddress": "fa16.3eef.ae56",
            "ipAddress": null,
            "assignedType": "",
            "type": "DATA"
        },
        {
            "id": 5,
            "name": "GigabitEthernet5",
            "status": "AVAILABLE",
            "operationalStatus": "down",
            "macAddress": "fa16.3e03.ee0b",
            "ipAddress": null,
            "assignedType": "",
            "type": "DATA"
        },
        {
            "id": 6,
            "name": "GigabitEthernet6",
            "status": "AVAILABLE",
            "operationalStatus": "down",
            "macAddress": "fa16.3ea3.bee5",
            "ipAddress": null,
            "assignedType": "",
            "type": "DATA"
        },
        {
            "id": 7,
            "name": "GigabitEthernet7",
            "status": "AVAILABLE",
            "operationalStatus": "down",
            "macAddress": "fa16.3eb6.86f0",
            "ipAddress": null,
            "assignedType": "",
            "type": "DATA"
        },
        {
            "id": 8,
            "name": "GigabitEthernet8",
            "status": "AVAILABLE",
            "operationalStatus": "down",
            "macAddress": "fa16.3e48.4c07",
            "ipAddress": null,
            "assignedType": "",
            "type": "DATA"
        },
        {
            "id": 9,
            "name": "GigabitEthernet9",
            "status": "AVAILABLE",
            "operationalStatus": "down",
            "macAddress": "fa16.3eca.19fc",
            "ipAddress": null,
            "assignedType": "",
            "type": "DATA"
        },
        {
            "id": 10,
            "name": "GigabitEthernet10",
            "status": "ASSIGNED",
            "operationalStatus": "down",
            "macAddress": "fa16.3e94.1577",
            "ipAddress": null,
            "assignedType": "test_approval_vikrant(nfv-sp-DC1)",
            "type": "DATA"
        }
    ],
}

The description of the response:

Field Name Type Example Values Description
uuid string ec68e425-f973-452e-a866-76be5844d0ba Unique Id of the virtual device (uuid).
name string Test-device-003-SROY Name of the virtual device.
deviceTypeCode string C8000V Device type code.
deviceTypeName string C8000V (Autonomous mode) Device type name.
deviceTypeVendor string Cisco Vendor of the device.
deviceTypeCategory string ROUTER Category of the device.
diverseFromDeviceName string My-Other-Device The name of a device that is in a location different from this device.
diverseFromDeviceUuid string 4cfb5675-5c3f-4275-adba-0c9e3c26c97b The unique Id of a device that is in a location different from this device.
status string PROVISIONED Status of the device.
licenseStatus string REGISTERED Status of the license.
metroCode string DC Metro where the device is located.
metroName string Ashburn Metro name.
ibx string DC1 Name of the Equinix exchange. A metro location may have several exchanges.
region string AMER The region in which the metro is located
throughput integer 500 Throughput of the device
throughputUnit string Mbps Throughput unit.
hostName string TC12 Host name.
packageCode string SEC Software package code.
packageName string Security Software package name.
version string 16.09.02 Version of the software.
licenseType string BYOL Type of license. As of now, we only offer BYOL.
licenseName string Bring Your Own License Name of license.
licenseFileld string 9125e24a-708b-4c6e-8694-2c3ca727b081 License file Id. You get a licenseFileId when you upload a license file from your vendor to Equinix.
createdBy string myna Created by.
createdDate string 2019-05-03T03:11:44.127Z Creation date.
deletedBy string myna Deleted by.
deletedDate string 2019-05-03T03:11:44.127Z Deletion date.
lastUpdatedBy string myna Last updated by.
lastUpdatedDate string 2019-05-03T03:11:44.127Z Last update date.
sshIpAddress string 101.97.33.201 Ip Address of the device.
deviceSerialNo string 92CONAW32JC The serial number of the device.
sshIpFqdn string testhost-201-33-97-101-SY.eis.lab.equinix.com The fully qualified domain name of the device.
sshIpFqdnStatus string ASSIGNED sshIpFqdnStatus. Applicable values:
  • ASSIGNED: Assigned DNS successfully
  • UNASSIGNED: We are in the process of assigning DNS
  • RELEASED: The DNS is released
accountNumber string 2252619 Account number.
accountName string nfv-sit1 Account name.
notifications array[] test@equinix.com List of email addresses that will receive notifications.
purchaseOrderNumber string 3456778 Customer's purchase order number.
redundancyType string PRIMARY Whether this device is primary or secondary. Secondary devices are redundant devices that ensure high availability.
redundantUuid string 086d0425-69b7-4c8e-8a29-a3d5a1e543da Unique Id of the redundant device. If this device is primary, then this field will have the unique Id of the secondary device. Otherwise, if this device is a secondary device, then this will field will have the unique Id of the primary device.
connectivity string INTERNET-ACCESS Specifies the connectivity on the device. Possible values:
  • INTERNET-ACCESS
  • PRIVATE: A private device will not have ACLs or bandwidth.
  • INTERNET-ACCESS-WITH-PRVT-MGMT
.
managementIp string 10.198.251.54/24 Management IP. This is an optional parameter relevant for SDWAN devices.
managementGatewayIp string 10.198.251.1 Management Gateway IP. This is an optional parameter relevant for SDWAN devices.
publicIp string 149.97.198.97/31 Public IP. This is an optional parameter relevant for SDWAN devices.
publicGatewayIp string 149.97.198.96 Public Gateway IP. This is an optional parameter relevant for SDWAN devices.
primaryDnsName string 4.0.0.53 Primary DNS name. This is an optional parameter relevant for SDWAN devices.
secondaryDnsName string 129.250.35.250 Secondary DNS name. This is an optional parameter relevant for SDWAN devices.
termLength integer 12 The term length of the contract.
newTermLength string 24 The future term length effective upon completion of the current term.
billingCommencementDate string 09/07/2020 21:16:49 Billing commencement date.
additionalBandwidth integer 100 Additional bandwidth in Mbps.
pricingDetails object An object that has the pricing details of a quote created for Network Edge on Siebel.
termLength string 36 The term length of a quote created for Network Edge on Siebel.
orderNumber string 1-198735018693 The order number of a quote created for Network Edge on Siebel.
core integer 4 The number of cores on a quote created for Network Edge on Siebel.
throughput integer 1 The throughput on a quote created for Network Edge on Siebel.
throughputUnit string Gbps The throughput unit on a quote created for Network Edge on Siebel.
packageCode string AX The software package on a quote created for Network Edge on Siebel.
additionalBandwidth string 100 The additional bandwidth on a quote created for Network Edge on Siebel.
channelPartner string SDCI The name of the channel partner.
primary object An object with the pricing details of the primary device.
charges array An array with all the charges.
description string VIRTUAL_DEVICE The description of the price.
monthlyRecurringCharges string 200 The monthly recurring charges.
currency string USD The currency of the price.
secondary object An object with the pricing details of the secondary device.
interfaceCount integer 24 The total number of interfaces.
core object An object with the details of the core.
core.core integer 2 The number of cores.
core.memory integer 4 The amount of memory.
core.unit string GB The unit of memory.
core.tier integer 2 Tier is only relevant for Cisco 8000v devices.
deviceManagementType string SELF-CONFIGURED Whether the device is SELF-CONFIGURED or not.
licenseKey string 1404-991d81bb-2567-43e5-a14c-1493ace58046 License key (ION key). Relevant only for CloudGenix devices.
licenseSecret string d29dceeef2d2b494c9eb76937a361890786e609d License secret (Secret key). Relevant only for CloudGenix devices.
localId string SDWAN-Branch@Versa.com Email address of the branch location. Relevant only for Versa SD-WAN devices.
remoteId string Controller-01-staging@Versa.com Email address of the controller side. Relevant only for Versa SD-WAN devices.
controller1 string 54.219.248.29 Ip address of the SD-WAN controller1. Relevant only for Versa SD-WAN devices.
controller2 string 54.177.220.115 Ip address of the SD-WAN controller2. Relevant only for Versa SD-WAN devices.
userPublicKey object An object that has the SSH public key details. Relevant only for self-configured devices.
username string test-user1 The SSH username. Relevant only for self-configured devices.
publicKeyName string test-pk-2 The SSH publicKeyName. Relevant only for self-configured devices.
publicKey string ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\n The SSH publicKey. Relevant only for self-configured devices.
publicKeyType string RSA The SSH publicKeyType, whether RSA or DSA.
clusterDetails object An object that has the cluster details. This field is only relevant for cluster devices.
clusterId string 34b7838c-ec82-4166-ac19-efa03b4e34fe The Id of the cluster. This field is only relevant for cluster devices.
clusterName string myClusterDevice The name of the cluster device. This field is only relevant for cluster devices.
numOfNodes integer 2 The number of nodes in the cluster. This field is only relevant for cluster devices.
nodes array[objects] An array of the two node objects
name string myClusterDevice-Node0 The name of the node. This field is only relevant for cluster devices.
uuid string 34b7838c-ec82-4166-ac19-efa03b4e34fe The unique Id of the node. This field is only relevant for cluster devices.
node integer 0 The sequence number of the node. This field is only relevant for cluster devices.
vendorConfig object An object that has the fields relevant to the vendor of the device.
vendorConfig.adminPassword string ZQelDI7sUd The administrative password of the device. You can use it to log in to the console. This field is not available for all device types.
vendorConfig.siteId string 567 Site Id. Relevant only for Cisco SD-WAN devices. A siteId is a particular physical location within the Viptela overlay network, such as a branch office, or a campus.
vendorConfig.systemIpAddress string 2.2.2.2 System IP address. Relevant only for Cisco SD-WAN devices. Each CSRSDWAN router and vSmart controller is assigned a system IP address.
vendorConfig.connectToCloudVision boolean true Only relevant for Arista devices. A "true" value means your Arista device is connected to Cloud Vision.
vendorConfig.cvpType string As-a-Service or On-Premise Only relevant for Arista devices.
vendorConfig.cvpFqdn string www.NetworkSolutions.com Fully qualified domain name for Cloud Vision As-a-Service. Only relevant for Arista devices.
vendorConfig.cvpIpAddress string 192.168.0.10 Only relevant for Arista devices. Cloud Vision Portal's IP address.
vendorConfig.cvaasPort string 443 Cvaas Port number. Only relevant for Arista devices.
vendorConfig.cvpPort string 443 Cloud Vision Portal's port number. Only relevant for Arista devices.
vendorConfig.cvpToken string 123 Cloud Vision Portal's token. Only relevant for Arista devices.
vendorConfig.privateAddress string 192.168.20.32 Private address. Relevant for BlueCat devices.
vendorConfig.privateCidrMask string 24 Private CIDR Mask. Relevant for BlueCat devices.
vendorConfig.privateGateway string 192.168.20.1 Private gateway. Relevant for BlueCat devices.
vendorConfig.licenseId string 000000123457777 License Id. Relevant for BlueCat devices.
vendorConfig.panoramaIpAddress string 1.1.1.1 IP address of the Panorama controller for Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access
vendorConfig.panoramaAuthKey string 123456 Supports secure onboarding of Palo Alto firewall devices (Panorama integration). Relevant for Palo Alto Self-Configured devices with Internet Access.
serialNumber string 4545454 The customer selects a serial number when setting up the device template on Versa director. Relevant only for Versa SD-WAN devices.
plane string PRIMARY Compute plane. This field indicates whether the device is PRIMARY or SECONDARY.
interfaces array[object] An array of interface objects.
id integer 1 Id of the interface.
name string GigabitEthernet1 Name of the interface.
status string AVAILABLE Status of the interface, whether it is AVAILABLE, RESERVED, or ASSIGNED. Assigned interfaces are already in use. Reserved interfaces can only be used to bring your own connection (BYOC) from your Network Service Providers.
operationStatus string down Operation status of the interface, whether it is up or down.
macAddress string fa16.3e1c.a8d8 Media access control address. It is the hardware identification number that uniquely identifies each device on a network.
ipAddress string 2.2.2.2 Ip address.
assignedType string Equinix Managed Equinix managed interfaces are not available to create connections.
type string MGMT The type of interface.
asn integer 1029 Global ASN of the device.

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

Update Device Draft

PUT /ne/v1/devices/{uuid}
Method PUT
URL or End Point /ne/v1/devices/{uuid}
Headers Authorization, Content-Type
Query Parameters draft
Path Parameters uuid
Body Parameters additionalBandwidth, deviceTypeCode, hostNamePrefix, licenseFileId, licenseKey, licenseMode, licenseSecret, licenseToken, metroCode, notifications[...], packageCode, siteId, sshUsers[sshUserUuid, action, sshUsername, sshPassword], systemIpAddress, termLength, throughput, throughputUnit, virtualDeviceName, acl[...], accountNumber, accountReferenceId, purchaseOrderNumber, secondary {accountNumber, accountReferenceId, acl[...], additionalBandwidth, licenseFileId, licenseKey, licenseSecret, licenseToken, metroCode, notifications[...], siteId, sshUsers[{sshUserUuid, action, sshUsername, sshPassword}], systemIpAddress, virtualDeviceName"}

Updates a draft device.

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

Sample curl request:

Copy 
curl -X
PUT "https://api.equinix.com/ne/v1/devices/fa02d9df-75c2-4763-b9f7-89a06bf6376a?draft=true"
-H "content-type: application/json"
-H "Authorization: Bearer jnSoUKaJHpzMnU0toROpUHmqnwEP"
-d '{
    "additionalBandwidth": 100,
    "deviceTypeCode": "C8000V",
    "hostNamePrefix": "myhostSR",
    "licenseToken": "ASGIFSD989FSDFDSi90f43fdsgfd543534%43$ASGIFSD989FSDFDSi90f43fdsgfd543534",
    "licenseMode": "BYOL",
    "metroCode": "DC",
    "notifications": [
        "test1@example.com"
    ],
    "packageCode": "IPBASE",
    "sshUsers": [
    {
        "sshUserUuid": "",
        "action": "CREATE",
        "sshUsername": "cust0001_DC",
        "sshPassword": "projPass"
    }
    ],
    "termLength": 1,
    "throughput": 500,
    "throughputUnit": "Mbps",
    "virtualDeviceName": "Router8000v",
    "acl": [
        "192.168.1.1/29"
    ],
    "accountNumber": "708979",
    "purchaseOrderNumber": "123456"
}'

Query parameter:

Query Parameter Name Mandatory Type Example Possible Values Description
draft Yes boolean True True To save a draft, set draft=true. You cannot create/update a provisioned device using this API. You must provide deviceTypeCode, accountNumber/accountReferenceId, and metroCode to save a draft. SshUsers and licenseFileId information will not be saved for drafts. Also, this API will not do access control list validation when you save a draft.

Path parameter:

Path Parameter Name Mandatory Type Example Possible Values Description
uuid Yes string ec68e425-f973-452e-a866-76be5844d0ba The unique Id of the draft (draftUuid).

Body parameters:

Body Parameter Name Mandatory Type Example Possible Values Description
additionalBandwidth No integer 100 Additional bandwidth. You may have a different additional bandwidth for your secondary device, in case you have a secondary device for high availability.
deviceTypeCode Yes string C8000V Virtual device type (device type code).
hostNamePrefix No string mySE Host name prefix. This gets included as part of an FQDN that ensures that the device is reachable from approved sources, if desired. Only a-z, A-Z, 0-9 and hyphen(-) are allowed. It should start with a letter and end with a letter or a digit. Also, it should be a minimum of 2 and a maximum of 10 characters long.
licenseFileID No string 6651aef5-e738-411f-8675-5f6b7b9cd429 License file Id is mandatory for some devices. For Juniper redundant devices, you may use the same license file for both devices.
licenseKey No string 6735-vwe64568-6a91-4112-8734-bea12d91f7y7 License key (primarily for CloudGenix SDWAN devices).
licenseMode No string BYOL BYOL License type. As of now, we only offer BYOL (bring your own license).
licenseSecret No string h5j0i45e83324pblbfca764532c4a640e7801f0 License secret (primarily for CloudGenix SDWAN devices).
licenseToken No string V74191621 License token is mandatory for some devices that provide/accept a license token. You do not need to provide a license token if your vendor provides license files.
metroCode Yes string SV Metro code. You do not need to provide two different metros for your redundant device, but you may if you want to.
notifications No array [test1@example.com] Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses. You may have a different notification list for your secondary device in case you are creating a redundant device.
packageCode No string VM100 Software package code.
siteId No string Site Id. A siteId is a particular physical location within the Viptela overlay network, such as a branch office or a campus.
sshUsers No array[object] [{
"sshUserUuid": "",
"action": "CREATE",
"sshUsername": "cust00011_DCT",
"sshPassword": "projPass!"
}] 		SSH users. You may have two distinct sets of ssh users in case you have a redundant device.
sshUserUuid No string ef673cd4-9fc2-4ab4-810e-7274aaf7bc2d Required for DELETE, REUSE operations. In case you want to REUSE an existing user, please provide the unique Id of the user.
action No string CREATE CREATE, DELETE, REUSE Action to be performed, whether you want to create a new user, delete a user, or reuse a user.
sshUsername No string cust00011_DCT SSH username.
sshPassword No string projPass! SSH user password.
systemIpAddress No string 192.168.1.5 System Ip Address. Mandatory for Cisco SDWAN devices. Each vEdge router and vSmart controller is assigned a system IP address. It should be in decimal four-part dotted notation, just like IPv4 address.
termLength No integer 12 Billing term length in months.
throughput No integer 500 Throughput of the device.
throughputUnit No string Mbps Throughput unit.
virtualDeviceName No string CiscoSTROY Virtual device name for identification. This should be a minimum of 3 and a maximum of 50 characters long.
acl No array[string] ["192.168.10.0/24"] IP addresses, no more than 50, in CIDR format. You may have two distinct sets of ACLs in case you have a redundant device.
accountNumber No string 10478397 Account number. Either an account number or an account referenceId is required to create a draft device.
accountReferenceId No string 791281 Account reference Id. This is a temporary ID that can be used to create a draft device when your account is still pending, not active. Either an account number or an account referenceId is required to create a draft device.
purchaseOrderNumber No string 3456789 Purchase order number. Optional field that customers can use to track this device creation to their own purchase order number.
secondary No object secondary{} An object containing the optional secondary device details.

Sample response.

Copy 
204: No Content

The description of the response payload:

HTTP status Description
204 The request was successfully processed.

Query the details of a draft by calling Get Virtual Device {uuid}. You can delete a draft by calling Delete Virtual Devices.

Get Device Interfaces

GET /ne/v1/devices/{uuid}/interfaces
Method GET
URL or End Point /ne/v1/devices/{uuid}/interfaces
Headers Authorization, Content-Type
Path Parameter uuid
Body Not applicable

Returns the status of the interfaces of a device.

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

Sample curl request:

Copy 
curl -X
GET "https://api.equinix.com/ne/v1/devices/ec68e425-f973-452e-a866-76be5844d0ba/interfaces"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string ec68e425-f973-452e-a866-76be5844d0ba Unique Id of a virtual device.

Sample response:

Copy 
[
    {
        "id": 1,
        "name": "fxp0",
        "status": null,
        "operationalStatus": null,
        "macAddress": null,
        "ipAddress": null,
        "assignedType": "Equinix Managed",
        "type": "MGMT"
    },
    {
        "id": 2,
        "name": "ge-0/0/0",
        "status": null,
        "operationalStatus": null,
        "macAddress": null,
        "ipAddress": null,
        "assignedType": "Equinix Managed",
        "type": "SSH"
    },
    {
        "id": 3,
        "name": "ge-0/0/1",
        "status": "RESERVED",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:06:93:69",
        "ipAddress": null,
        "assignedType": "Connection to Network Service Provider",
        "type": "DATA"
    },
    {
        "id": 4,
        "name": "ge-0/0/2",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:e2:32:96",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    },
    {
        "id": 5,
        "name": "ge-0/0/3",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:31:b3:01",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    },
    {
        "id": 6,
        "name": "ge-0/0/4",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:42:a7:60",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    },
    {
        "id": 7,
        "name": "ge-0/0/5",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:d8:4c:cc",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    },
    {
        "id": 8,
        "name": "ge-0/0/6",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:5d:12:f8",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    },
    {
        "id": 9,
        "name": "ge-0/0/7",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:07:f5:9f",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    },
    {
        "id": 10,
        "name": "ge-0/0/8",
        "status": "AVAILABLE",
        "operationalStatus": "up",
        "macAddress": "fa:16:3e:63:f1:51",
        "ipAddress": null,
        "assignedType": "",
        "type": "DATA"
    }
]

The description of the response:

Field Name Type Example Values Possible Values Description
id string 10 Id of an interface.
name string ethernet1/9 Name of the interface.
status string AVAILABLE AVAILABLE, ASSIGNED, RESERVED Assigned interfaces are already in use. Reserved interfaces can only be used to bring your connection (BYOC) from your Network Service Provider.
operationalStatus string down up, down Operational status of the interface, whether it is up or down.
macAddress string fa:16:3e:5f:41:06 Media access control address.
ipAddress string Ip address.
assignedType string test(AWS Direct Connect) This field has the connection name and the service profile of the connection in brackets.
type string Data Type of interface.
asn integer 1029 ASN number.

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

Update Additional Bandwidth

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

Call this API to update the additional bandwidth of an existing device or add additional bandwidth to an existing device that is registered and provisioned. You must have set up an ACL (access control) list before you can add additional bandwidth to a device.

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

Copy 
curl -X
PUT "https://api.equinix.com/ne/v1/devices/f61e75d2-2008-43f4-bfee-1dd17b1e1a28/additionalBandwidths"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d "{
"additionalBandwidth": 200
}"

The description of the path parameter is as follows:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string f61e75d2-2008-43f4-bfee-1dd17b1e1a28 The unique Id of a virtual device.

The description of the body is as follows:

Body Parameter Name Mandatory Type Example Applicable Values Description
additionalBandwidth Yes integer 200 Additional bandwidth.
Copy 
204 No Content

The description of the response payload is as follows:

HTTP status Description
204 No Content The request was successfully processed.

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

Ping Virtual Device

GET /ne/v1/devices/{uuid}/ping
Method GET
URL or End Point /ne/v1/devices/{uuid}/ping
Headers Authorization, Content-Type
Path Parameter uuid
Body Not applicable

Pings a virtual device to ensure it's reachable. At this point, you can only ping a few SELF-CONFIGURED devices.

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

The following screenshots show a sample curl request and its respective JSON response.

Copy 
curl -X
GET "https://api.equinix.com/ne/v1/devices/01425e3b-0e37-4539-af09-5b26cb9bad18/ping"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string ec68e425-f973-452e-a866-76be5844d0ba The unique ID of the virtual device.

Sample response:

Copy 
200 okay

The description of the response is as follows:

HTTP status Description
200 The device is reachable.

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

Delete Virtual Devices

DELETE /ne/v1/devices/{uuid}
Method DELETE
URL or End Point /ne/v1/devices/{uuid}
Headers Authorization, Content-Type
Query Parameter deleteRedundantDevice
Path Parameter uuid
Body deactivationKey

Deletes a virtual device. For some devices, you only need to pass the device Id as a path parameter. For Palo Alto BYOL devices, you can also provide a deactivation key as a body parameter. If you do not provide a deactivation key for a Palo Alto BYOL device, you must contact your vendor to release the license.

For a redundant device pair, the query parameter "deleteRedundantDevice" must be marked "True" so we delete both the devices simultaneously.

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

Sample curl request to delete a Palo Alto device.

Copy 
curl -X
DELETE "https://api.equinix.com/ne/v1/devices/5f888d91-d2c5-45bb-9b51-fed99f57f0ac?deleteRedundantDevice=True"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "deactivationKey": "8fdsfds9gdf7gdfldfsafdsfdsa898gdfsgfd8990908gdfsgdfgdsfgfd90gdf90g",
    "secondary": {
    "deactivationKey": "8fdsfds9gdf7gdfldfsafdsfdsa898gdfsgfd8990908gdfsgdfgdsfgfd90gdf90g"
    }
}'

Sample curl request to delete a Cisco device.

Copy 
curl -X
DELETE "https://api.equinix.com/ne/v1/devices/6f888d91-d2c5-45bb-9b51-fed99f57f0ac?deleteRedundantDevice=True"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 5f888d91-d2c5-45bb-9b51-fed99f57f0ac Unique Id of the virtual device.

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
deleteRedundantDevice No Boolean True Optional parameter in case you have a secondary device. As both primary and secondary devices are deleted simultaneously, this field must be marked True for Equinix to successfully delete both the devices.

Body parameter:

Body Parameter Name Mandatory Type Example Applicable Values Description
deactivationKey No string 8dfbd5ba3610234d9e550032603cc34762af1
40533e2c1de0111d3451SAMPLE 		If you do not provide a deactivation key for a Palo Alto BYOL device, you must contact your vendor to release the license.
secondary No object An object that has the secondary deactivation key.

Sample response:

Copy 
204 No Content : Deletion request accepted.

Response payload:

HTTP status Description
204 No Content Deletion request successfully accepted.

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

Update Virtual Device

PATCH /ne/v1/devices/{uuid}
Method PATCH
URL or End Point /ne/v1/devices/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Body Parameters core, notifications[...], termLength, termLengthEffectiveImmediate. virtualDeviceName, clusterName, status, vendorConfig, autoRenewalOptOut

Updates the name, term length, core, status, vendorConfig fields, autoRenewalOptOut, and notification list of a device.

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

Sample curl request:

Copy 
curl -X
PATCH "https://api.equinix.com/ne/v1/devices/fa02d9df-75c2-4763-b9f7-89a06bf6376a"
-H "content-type: application/json"
-H "Authorization: Bearer jnSoUKaJHpzMnU0toROpUHmqnwEP"
-d '{
    "notifications": [
    "test@equinix.com"
    ],
    "termLength": 12,
    "termLengthEffectiveImmediate": false,
    "virtualDeviceName": "Auto_SROY_11-21",
    "autoRenewalOptOut": true,
    "vendorConfig": {
    "disablePassword": true
    }
}
'

Path parameter:

Path Parameter Name Mandatory Type Example Possible Values Description
uuid Yes string ec68e425-f973-452e-a866-76be5844d0ba The unique Id of a device.

Body parameters:

Body Parameter Name Mandatory Type Example Possible Values Description
core No integer 8 Use this field to resize your device. When you call this API for resizing, you cannot change other fields simultaneously.
notifications No array [test1@example.com] Email addresses for device life-cycle notifications. Equinix needs a minimum of 1 and no more than 5 email addresses. You may have a different notification list for your redundant device.
termLength No integer 1,12,24, 36 Term length in months. Billing term length in months.
termLengthEffectiveImmediate No boolean false By default, this field is true. Set it to false if you want to change the termLength at the end of the current term. You cannot downgrade the termLength before the end of your current term.
virtualDeviceName No string CiscoSTROY Virtual device name. This should be a minimum of 3 and a maximum of 50 characters.
clusterName No string newClusterName Use this field to update a cluster name.
status No string PROVISIONED Use this field to update the license status of a device.
vendorConfig No object Use this object to update vendorConfig fields.
disablePassword No boolean true Disable the password of the device.
autoRenewalOptOut No boolean true By default, this field is set to 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.

Sample response.

Copy 
204: No Content

Description:

HTTP status Description
204 The request was successfully fulfilled.

Get Device Reload History

GET /ne/v1/devices/{virtualDeviceUUID}/softReboot
Method GET
URL or End Point /ne/v1/devices/{virtualDeviceUUID}/softReboot
Headers Authorization, Content-Type
Query Parameters offset, limit
Path Parameters virtualDeviceUUID
Body Not applicable

Returns the reload history of a device.

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

Sample curl request:

Copy 
curl -X
GET "https://api.equinix.com/ne/v1/devices/{virtualDeviceUUID}/softReboot"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
offset No integer 0 Specifies where to start a page. It is the starting point of the collection returned from the server.
limit No integer 100 Specifies the page size.

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
virtualDeviceUUID Yes string 4cfb5675-5c3f-4275-adba-0c9e3c26c96b The unique Id of a virtual device.

Sample response:

Copy 
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"deviceUUID": "2a6f1f8c-525d-486b-9985-c43058b502ef",
"status": "SUCCESS",
"requestedBy": "eqxnfvuser1",
"requestedDate": "2021-10-15T22:05:40.657Z",
"completionDate": "2021-10-15T22:18:28.054Z"
}
]
}

Description of the response payload:

Field Name Type Example Values Description
pagination object An object with pagination information.
offset integer 0 It is the starting point of the collection returned from the server.
limit integer 20 Page size.
total integer 100 The total number of results.
next string The next result set.
previous string The previous result set.
data array An array containing device-type objects.
deviceUUID string ac8a8497-1b6e-42d1-9075-acf23a62ed50 Unique Id of the device.
status string SUCCESS The reboot was successful.
Possible values: REBOOT_REQUESTED, IN_PROGRESS, SUCCESS, FAILED.
requestedBy string eqxnfvuser1 Requested by.
requestedDate string 2021-10-15T22:05:40.657Z Requested date.
completionDate string 2021-10-15T22:05:40.657Z Completion date.

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

Trigger Soft Reboot

POST /ne/v1/devices/{virtualDeviceUUID}/softReboot
Method POST
URL or End Point /ne/v1/devices/{virtualDeviceUUID}/softReboot
Headers Authorization, Content-Type
Query Parameters Not applicable
Path Parameter virtualDeviceUUID

Triggers the soft reboot of a device.

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

Sample curl request:

Copy 
curl -X
POST "https://api.equinix.com/ne/v1/devices/{virtualDeviceUUID}/softReboot"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
virtualDeviceUUID Yes string ac8a8497-1b6e-42d1-9075-acf23a62ed50 The unique Id of a device.

Sample response:

Copy 
201 Created

The description of the response payload:

Status Description
201 A request to trigger a soft reboot has been created. To query the status of the reboot, please call Get Device Reload History.

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

Get Interface Statistics

GET /ne/v1/devices/{virtualDeviceUuid}/interfaces/{interfaceId}/stats
Method GET
URL or Endpoint /ne/v1/devices/{virtualDeviceUuid}/interfaces/{interfaceId}/stats
Headers Authorization, Content-Type
Path Parameters virtualDeviceUuid, interfaceId
Query Parameters startDateTime, endDateTime
Body Parameters Not applicable

Returns the throughput statistics of a device interface.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/ne/v1/devices/abd643a3-c91f-4aae-829f-861d170579e2/interfaces/4/stats?startDateTime=2023-11-10T19:06:06Z&endDateTime=2023-11-17T19:06:06Z'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter name
Description
virtualDeviceUuid string
REQUIRED		 Unique Id of a device.
Example: abd643a3-c91f-4aae-829f-861d170579e2
interfaceId integer
REQUIRED		 Interface Id of the device.
Example: 4

Query parameters

Parameter name
Description
startDateTime string
REQUIRED		 Start time of the duration for which you want stats. Format: YYYY-MM-DDThh:mm:ssZ.
Example: 2021-01-07T19:26:22Z
endDateTime string
REQUIRED		 End time of the duration for which you want stats. Format: YYYY-MM-DDThh:mm:ssZ.
Example: 2021-01-07T19:30:22Z

Sample response

Copy 
{
    "stats": {
        "startDateTime": "2023-11-10T19:06:06Z",
        "endDateTime": "2023-11-11T19:06:06Z",
        "unit": "Mbps",
        "inbound": {
            "max": 29.906034624747683,
            "mean": 6.341387726453309,
            "lastPolled": 4.2551751570268115,
            "metrics": [
                {
                    "intervalEndDateTime": "2023-11-10T19:32:14Z",
                    "mean": 26.400827255770395
                },
                {
                    "intervalEndDateTime": "2023-11-10T19:37:34Z",
                    "mean": 20.391284894943237
                },
                {
                    "intervalEndDateTime": "2023-11-10T19:42:16Z",
                    "mean": 20.818065426873822
                }
            ]
        },
        "outbound": {
            "max": 125.17436381084163,
            "mean": 12.167520951671307,
            "lastPolled": 8.862741237733422,
            "metrics": [
                {
                    "intervalEndDateTime": "2023-11-10T19:32:14Z",
                    "mean": 9.549439345514042
                },
                {
                    "intervalEndDateTime": "2023-11-10T19:37:34Z",
                    "mean": 9.325965023040771
                },
                {
                    "intervalEndDateTime": "2023-11-10T19:42:16Z",
                    "mean": 12.87771525281541
                }
    
            ]
        }
    }
}

Response payload body description

Parameter
Description
stats object
 An object that has the throughput statistics of the interface.
startDateTime string
 Start time of the duration for which you want stats.
Example: 2023-11-10T19:06:06Z
endDateTime string
 End date and time of the duration for which you want stats.
Example: 2023-11-17T19:06:06Z
unit string
 Unit.
Example: Mbps
inbound object
 An object that has the stats of inbound traffic.
max number
 Max throughput during the time interval.
Example: 26.400827255770395
mean number
 Mean throughput during the time interval.
Example: 6.341387726453309
lastPolled number
 The throughput of the last polled data.
Example: 4.2551751570268115
metrics array
 An array that has a list of mean traffic and the interval end times.
intervalEndDateTime string
 The end of a polled time period.
Example: 2023-11-10T19:32:14Z
mean number
 Mean traffic throughput.
Example: 26.400827255770395
outbound object
 An object that has the stats of outbound traffic.

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

Get Device Upgrade History

GET /ne/v1/devices/{virtualDeviceUuid}/resourceUpgrade
Method GET
URL or End Point /ne/v1/devices/{virtualDeviceUuid}/resourceUpgrade
Headers Authorization, Content-Type
Query Parameters offset, limit
Path Parameters virtualDeviceUuid
Body Not applicable

Returns the upgrade history of a device.

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

Sample curl request:

Copy 
curl -X
GET "https://api.equinix.com/ne/v1/devices/{virtualDeviceUuid}/resourceUpgrade"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
offset No integer 0 Specifies where to start a page. It is the starting point of the collection returned from the server.
limit No integer 100 Specifies the page size.

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
virtualDeviceUuid Yes string 4cfb5675-5c3f-4275-adba-0c9e3c26c96b The unique Id of a virtual device.

Sample response:

Copy 
{
    "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1
    },
    "data": [
                {
                    "uuid": "be7ef79e-31e7-4769-be5b-e192496f48aa",
                    "virtualDeviceUuid": "8ed6ffcb-cef5-4801-83a3-2aa2b6c682f0",
                    "status": "SUCCESS",
                    "requestedDate": "2020/10/03T19:41:17.976Z",
                    "completiondDate": "2020/10/03T19:41:17.976Z",
                    "requestedBy": "eqxnfvuser1"
                }
    ]
}

Description of the response payload:

Field Name Type Example Values Description
pagination object An object with pagination information.
offset integer 0 It is the starting point of the collection returned from the server.
limit integer 20 Page size.
total integer 100 The total number of results.
next string The next result set.
previous string The previous result set.
data array An array containing the details of upgrades.
uuid string nm8a8497-1b6e-42d1-9075-acf23a62ed70 Unique Id of the upgrade.
virtualDeviceUuid string ac8a8497-1b6e-42d1-9075-acf23a62ed50 Unique Id of the device.
status string SUCCESS The status of the upgrade.
Possible values: REQUEST_ACCEPTED, IN_PROGRESS, SUCCESS, FAILED, CANCELLED.
requestedBy string eqxnfvuser1 Requested by.
requestedDate string 2021-10-15T22:05:40.657Z Requested date.
completionDate string 2021-10-15T22:05:40.657Z Completion date.

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