Skip to main content
Index

Setup

GET Device Types

GET /ne/v1/device/type

 Method  GET
 URL or End Point  /ne/v1/device/type
 Headers  Authorization, Content-Type
 Query Parameters  deviceTypeCode, category, page, size
 Body  Not applicable

 

Returns device types (e.g., routers and firewalls) you can launch on the Network Edge platform. You will learn about the metro regions where virtual devices are available, vendors of devices, available software packages, and all possible licensing and throughput options. 

 

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

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/device/type"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
deviceTypeCode No string CSR1000V   Code of the device you want.
category No string ROUTER

"ROUTER",

"FIREWALL",

"SDWAN"

Type of device.
page No string 1   Page number. Default value=1.
size No string 100   Results per page. Default value=100.

 

 

Sample response:

{
    "totalCount": 1,
    "pageNumber": 1,
    "pageSize": 100,
    "content": [
        {
            "deviceTypeCode": "VSRX",
            "name": "vSRX",
            "description": "The [Juniper vSRX Virtual Firewall|https://www.juniper.net/us/en/products-services/security/srx-series/vsrx/] provides scalable, secure protection across private, public, and hybrid clouds. The vSRX offers the same features as our physical SRX Series firewalls but in a virtualized form factor. It offers the same features as the SRX appliance, including core firewall, robust networking, full next-gen capabilities, and automated life-cycle management.",
            "vendor": "Juniper Networks",
            "category": "FIREWALL",
            "maxInterfaceCount": 16,
            "defaultInterfaceCount": 10,
            "clusterMaxInterfaceCount": 8,
            "clusterDefaultInterfaceCount": 8,
            "availableMetros": [
                {
                    "metroCode": "DA",
                    "metroDescription": "Dallas",
                    "region": "AMER",
                    "availableZones": [
                        {
                            "zoneCode": "Zone1",
                            "zoneName": "Zone 1",
                            "clusterSupported": false
                        }
                    ]
                },
                {
                    "metroCode": "SY",
                    "metroDescription": "Sydney",
                    "region": "APAC",
                    "availableZones": [
                        {
                            "zoneCode": "Zone1",
                            "zoneName": "Zone 1",
                            "clusterSupported": false
                        },
                        {
                            "zoneCode": "Zone2",
                            "zoneName": "Zone 2",
                            "clusterSupported": false
                        }
                    ]
                }
            ],
            "softwarePackages": [
                {
                    "packageCode": "STD",
                    "name": "Standard",
                    "versionDetails": [
                        {
                            "version": "15.1X49-D142.1",
                            "imageName": "vsrx-15.1X49-D142.1",
                            "versionDate": "2019-01-01",
                            "status": "ACTIVE",
                            "stableVersion": true,
                            "allowedUpgradableVersions": [
                                "18.4R2-S1.4",
                                "19.1R1.6"
                            ],
                            "upgradeAllowed": false,
                            "releaseNotesLink": "https://www.juniper.net/documentation/product/en_US/vsrx"
                        },
                        {
                            "version": "18.4R2-S1.4",
                            "imageName": "vsrx-18.4R2-S1.4",
                            "versionDate": "2020-01-01",
                            "status": "ACTIVE",
                            "stableVersion": true,
                            "allowedUpgradableVersions": [
                                "15.1X49-D142.1",
                                "19.1R1.6"
                            ],
                            "upgradeAllowed": false,
                            "releaseNotesLink": "https://www.juniper.net/documentation/product/en_US/vsrx"
                        },
                        {
                            "version": "18.4R3-S2",
                            "imageName": "vsrx-18.4R3-S2",
                            "versionDate": "2020-07-23",
                            "status": "ACTIVE",
                            "stableVersion": true,
                            "upgradeAllowed": false,
                            "releaseNotesLink": "https://www.juniper.net/documentation/product/en_US/vsrx"
                        },
                        {
                            "version": "19.1R1.6",
                            "imageName": "vsrx-19.1R1.6",
                            "versionDate": "2020-01-01",
                            "status": "ACTIVE",
                            "stableVersion": true,
                            "allowedUpgradableVersions": [
                                "15.1X49-D142.1",
                                "18.4R2-S1.4"
                            ],
                            "upgradeAllowed": false,
                            "releaseNotesLink": "https://www.juniper.net/documentation/product/en_US/vsrx"
                        },
                        {
                            "version": "19.2R2.7",
                            "imageName": "vsrx-19.2R2.7",
                            "versionDate": "2020-07-23",
                            "status": "ACTIVE",
                            "stableVersion": true,
                            "upgradeAllowed": false,
                            "releaseNotesLink": "https://www.juniper.net/documentation/product/en_US/vsrx"
                        }
                    ]
                }
            ],
            "deviceManagementTypes": {
                "EQUINIX-CONFIGURED": {
                    "type": "EQUINIX-CONFIGURED",
                    "licenseOptions": {
                        "SUB": {
                            "type": "Sub",
                            "name": "Subscription",
                            "cores": [
                                {
                                    "core": 2,
                                    "memory": 4,
                                    "unit": "GB",
                                    "flavor": "small",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                },
                                {
                                    "core": 5,
                                    "memory": 8,
                                    "unit": "GB",
                                    "flavor": "medium",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                },
                                {
                                    "core": 9,
                                    "memory": 16,
                                    "unit": "GB",
                                    "flavor": "large",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                }
                            ],
                            "supported": true
                        },
                        "BYOL": {
                            "type": "BYOL",
                            "name": "Bring Your Own License",
                            "cores": [
                                {
                                    "core": 2,
                                    "memory": 4,
                                    "unit": "GB",
                                    "flavor": "small",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                },
                                {
                                    "core": 5,
                                    "memory": 8,
                                    "unit": "GB",
                                    "flavor": "medium",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                },
                                {
                                    "core": 9,
                                    "memory": 16,
                                    "unit": "GB",
                                    "flavor": "large",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                }
                            ],
                            "supported": true
                        }
                    },
                    "supportedServices": [
                        {
                            "name": "CLOUD_PROFILE",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "ACL",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "Additional Bandwidth",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "Console Access",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "VPN",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "INTERFACE_OVERLAY",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "BGP",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "SSH",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "Upgrade Device Version",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        }
                    ],
                    "supported": true,
                    "clusteringDetails": {
                        "clusteringEnabled": false,
                        "maxAllowedNodes": 2
                    }
                },
                "SELF-CONFIGURED": {
                    "type": "SELF-CONFIGURED",
                    "licenseOptions": {
                        "SUB": {
                            "type": "Sub",
                            "name": "Subscription",
                            "cores": [],
                            "supported": false
                        },
                        "BYOL": {
                            "type": "BYOL",
                            "name": "Bring Your Own License",
                            "cores": [
                                {
                                    "core": 2,
                                    "memory": 4,
                                    "unit": "GB",
                                    "flavor": "small",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "18.4R2-S1.4"
                                            ],
                                            "excludedClusterVersions": [
                                                "18.4R2-S1.4",
                                                "19.1R1.6",
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                },
                                {
                                    "core": 5,
                                    "memory": 8,
                                    "unit": "GB",
                                    "flavor": "medium",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "18.4R2-S1.4"
                                            ],
                                            "excludedClusterVersions": [
                                                "18.4R2-S1.4",
                                                "19.1R1.6",
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                },
                                {
                                    "core": 9,
                                    "memory": 16,
                                    "unit": "GB",
                                    "flavor": "large",
                                    "packageCodes": [
                                        {
                                            "packageCode": "STD",
                                            "excludedVersions": [
                                                "18.4R2-S1.4"
                                            ],
                                            "excludedClusterVersions": [
                                                "18.4R2-S1.4",
                                                "19.1R1.6",
                                                "15.1X49-D142.1"
                                            ],
                                            "supported": true
                                        }
                                    ],
                                    "supported": true
                                }
                            ],
                            "supported": true
                        }
                    },
                    "supportedServices": [
                        {
                            "name": "ACL",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": true
                        },
                        {
                            "name": "Additional Bandwidth",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": true
                        },
                        {
                            "name": "CLOUD_PROFILE",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": true
                        },
                        {
                            "name": "INTERFACE_OVERLAY",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": true
                        },
                        {
                            "name": "Console Access",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": true
                        },
                        {
                            "name": "SSH Interface Selection",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": false
                        },
                        {
                            "name": "SSH",
                            "required": false,
                            "packageCodes": [
                                "STD"
                            ],
                            "supportedForClustering": true
                        }
                    ],
                    "defaultAcls": {
                        "dnsServers": [
                            "8.8.8.8",
                            "8.8.4.4"
                        ],
                        "ntpServers": [
                            "216.239.35.0/28"
                        ]
                    },
                    "supported": true,
                    "clusteringDetails": {
                        "clusteringEnabled": true,
                        "maxAllowedNodes": 2
                    }
                }
            }
        }
    ]
}

 

Description of the response payload:

Field Name Type Example Values Description
totalCount integer 1 The total count of items.
pageNumber integer 1 The page number. 
pageSize integer 20 The number of items displayed per page. 
content array   An array containing the device type objects.
deviceTypeCode string CSR1000V The device type code.
name string CSR 1000V The name of the device.
description string The [Cisco CSR 1000v Router Series|https://www.cisco.com/c/en/us/products/routers/cloud-services-router-1000v-series/index.html] serves as a secure single-tenant router in a multi-tenant, shared-resource public cloud environment. It provides end-to-end managed connectivity, enabling the user to construct a secure network connection and seamlessly extend it to public and virtual private clouds. Deploy a complete, hypervisor-isolated, multiservice secure instance for each tenant. Secure features include IPsec VPNs and built-in zone-based firewalls, among others. The device description.
vendor string Cisco The vendor of the device.
category string ROUTER The type of virtual device, either ROUTER or FIREWALL.
maxInterfaceCount integer 24 The maximum number of available interfaces.
defaultIntefaceCount integer 10 The default interface count. 
clusterMaxInterfaceCount integer 8 The maximum number of available interfaces in case you are clustering.
clusterDefaultInterfaceCount integer 8 The default number of available interfaces in case you are clustering.
availableMetros array   An array of the available metro objects. 
metroCode string SV The metro code.
metroDescription string Silicon Valley The metro description.
region string AMER The metro region. 
availableZones array   An array that shows the available zones within the above metro.
zoneCode string Zone1 The zone code.
zoneName string Zone 1 The zone name.
clusterSupported boolean false Whether this zone supports cluster devices.
softwarePackages array   An array of software packages and their version details.
packageCode string APPX The package code.
name string AppX The software package name.
versionDetails array   An array of software versions.
version string 16.09.02 The version of the software.
imageName string csr-16.09.02 The image name of the sotware.
versionDate string 2019-01-01 The date this version was released.
status string ACTIVE The status of the version.
stableVersion string true Whether this version is stable.
allowedUpgradableVersions array ["16.09.03"] An array of allowed upgradable versions.
upgradeAllowed string false Whether you can upgrade from this version.
releaseNotesLink string https://www.cisco.com/c/en/us/products/routers/cloud-services-router-1000v-series/index.html The release notes link.
deviceManagementTypes object An object that has device management types. The device management type object.
type string EQUINIX-CONFIGURED device management type. The device type, either EQUINIX-CONFIGURED or SELF-CONFIGURED.
licenseOptions object   An object that has the available license options for the above device management type.
type string Sub The type of license.
name string Subscription The name of the license.
fileUploadForCluster boolean false Whether you can upload a license file for cluster devices.
cores array   An array that has the available core options for the above license and device management type.
core integer 2 The number of cores.
memory integer 4 The amount of memory.
unit string GB The unit of memory.
flavor string small The flavor of the core.
packageCodes array   An array of the package codes. 
packageCode string STD A software package compatible with the core.
excludedVersions array [18.4R2-S1.4] Versions that do not support the above package code and cores.
excludedClusterVersions array ["18.4R2-S1.4",
"19.1R1.6",
"15.1X49-D142.1"]
Versions that do not support cluster devices.
throughputs array   An array of the available throughput options for the package code.
supported string true Whether this throughput is supported.
throughput integer 500 The throughput amount.
throughputUnit string Mbps The unit of throughput.
supported string true Whether the software package is supported.
supported string true Whether the core is supported for the above license type.
supportedServices array   An array of supported services.
name string Additional Bandwidth The name of a supported service
required string false Whether the supported service is required.
packageCodes array   An array of package codes that support the service.
supportedForClustering boolean   Whether the service is available for cluster devices.
additionalFields array   An array of additional fields associated with the device type.
name string controller1 The name of the additional field.
required string true Whether this field is required at the time of device creation.
clusteringDetails object   An object that has clustering information for the device and device management type.
clusteringEnabled boolean true Whether clustering is supported for the device and device management type.
maxAllowedNodes integer 2 The number of nodes you can have for a cluster device.
defaultAcls object   An object that has the default ACLs of the self-configured device.
dnsServers array   An array that has the DNS servers of the self-configured device.
ntpServers array   An array that has the NTP servers of the self-configured device.

 

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

GET Metro

GET /ne/v1/device/metro

 Method  GET
 URL or End Point  /ne/v1/device/metro
 Headers  Authorization, Content-Type
 Query Parameters  region, page, size
 Body Parameters  Not applicable

 

Returns metros where the Network Edge platform is available. 

 

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

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/device/metro"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

 

Request parameters:

Field name Mandatory Type Example Applicable Values Description
region No string

AMER

AMER,

EMEA,

APAC

The geographic region code where the metro resides. Three possible regions are “AMER”, “EMEA” or “APAC”.
page No integer 1   Page number.
size No integer

20

  Results per page.

 

 

Sample response:

{
    "totalCount": 2,
    "pageNumber": 1,
    "pageSize": 20,
    "content": [
        {
            "region": "AMER",
            "availableZones": [
                {
                    "zoneCode": "Zone1",
                    "zoneName": "Zone 1",
                    "clusterSupported": false
                }
            ],
            "metroCode": "DA",
            "metroDescription": "Dallas"
        },
        {
            "region": "APAC",
            "availableZones": [
                {
                    "zoneCode": "Zone1",
                    "zoneName": "Zone 1",
                    "clusterSupported": false
                },
                {
                    "zoneCode": "Zone2",
                    "zoneName": "Zone 2",
                    "clusterSupported": false
                }
            ],
            "metroCode": "SY",
            "metroDescription": "Sydney"
        }
    ]
}

 

 

The description of the response payload:

Field name Type Example Description
totalCount string 2 The number of items returned.
pageNumber integer 1 Page number.
pageSize integer 20 The number of items displayed per page. 
content array   An array containing the metro objects.
region string

AMER

EMEA

APAC

The geographic code of the metro. 
availableZones array   An array that has all the available zones within the metro.
zoneCode string Zone1 The zone code.
zoneName string Zone 1 The zone name.
clusterSupported boolean false Whether this zone supports cluster devices.
metroCode string DC The two-character code used to denote the metro.
metroDescription string

London

The name of the metro.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Account {metro}

GET ne/v1/device/account/{metro}

 Method  GET
 URL or End Point  ne/v1/device/account/{metro}
 Headers  Authorization, Content-Type
 Path Parameters

 metro

 Query Parameters  accountUcmId
 Body  Not applicable

 

Returns account status. To create a virtual device, you must have an account in the metro where you want a virtual device, either in the Active or Pending state. 

 

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

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/device/account/SV"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountUcmId No string 678907   Unique Id of the account. A reseller querying for a customer's devices can pass the accountUcmId of the customer's account. 

 

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
metro Yes string

SV

 

The two-character metro code.

 

Sample response:

{
    "accountCreateUrl": "https://dev-nfv.corp.equinix.com/account?referenceId=79160&ibx=SV6&metro=SV&callbackId=a6cd9158-6280-4864-b57e-79b46a128568",
    "accounts": [
        {
            "accountName": "FACEBOOK INC",
            "accountNumber": "110249",
            "accountUcmId": "1000014389",
            "accountStatus": "Active"
        },
        {
            "accountName": "REG2-acc1",
            "accountNumber": "2201097",
            "accountUcmId": "1000014389",
            "accountStatus": "Active"
        },
        {
            "accountName": "FACEBOOK INC",
            "accountNumber": "133911",
            "accountUcmId": "1000008582",
            "accountStatus": "Active"
        },
        {
            "accountName": "Facebook, Inc.",
            "accountNumber": "350603",
            "accountUcmId": "1000675853",
            "accountStatus": "Active"
        },
        {
            "accountName": "Facebook, Inc.",
            "accountNumber": "4257",
            "accountUcmId": "1000007224",
            "accountStatus": "Active"
        },
        {
            "accountName": "TestXXX02",
            "accountStatus": "PROCESSING",
            "referenceId": "791281"
        },
        {
            "accountName": "TestSameAsHqAddress",
            "accountNumber": "",
            "accountStatus": "PROCESSING",
            "referenceId": "762452"
        },
        {
            "accountName": "TestAccountXXX01",
            "accountNumber": "",
            "accountStatus": "PROCESSING",
            "referenceId": "783903"
        },
        {
            "accountName": "Test-xxxxx022",
            "accountUcmId": "24234234-2348-SUDF",
            "accountStatus": "PROCESSING",
            "referenceId": "949134"
        },
        {
            "accountName": "Test-xxxxx028",
            "accountNumber": "",
            "accountStatus": "SUBMITTED",
            "referenceId": "258089"
        },
        {
            "accountName": "TestAc02Oct08",
            "accountNumber": "",
            "accountStatus": "PROCESSING",
            "referenceId": "871892"
        },
        {
            "accountName": "TestAc01Oct08",
            "accountNumber": "",
            "accountStatus": "PROCESSING",
            "referenceId": "320082"
        },
        {
            "accountName": "TESTACC01OCT08",
            "accountStatus": "PROCESSING",
            "referenceId": "636589"
        },
        {
            "accountName": "TestAc01Oct08",
            "accountNumber": "",
            "accountStatus": "PROCESSING",
            "referenceId": "324092"
        },
        {
            "accountName": "TESTACC02OCT08",
            "accountStatus": "PROCESSING",
            "referenceId": "883018"
        },
        {
            "accountName": "TestXXX01",
            "accountStatus": "PROCESSING",
            "referenceId": "189798"
        },
        {
            "accountName": "TestAccount -XXX025",
            "accountStatus": "PROCESSING",
            "referenceId": "921696"
        },
        {
            "accountName": "Reseller Org",
            "accountNumber": "1352619",
            "accountUcmId": "3367D27E-1899-41a5-8AB6-0AC551FF4C01",
            "accountStatus": "Active"
        },
        {
            "accountName": "Subaccount Org",
            "accountNumber": "3472619",
            "accountUcmId": "62C928C4-CD82-4f66-9B5E-C59AF317F61D",
            "accountStatus": "Active"
        }
    ],
    "errorMessage": null,
    "errorCode": null
}

 

Response payload:

Field  Name Type Example Description
accountCreateURL string

https://ecxfabric.equinix.com/account?referenceId=459019&ibx=SV5&metro=SV&callbackId=062bcc1c-e319-42be-9674-200f19b6c3b4

URL to create an account. The accountCreate URL will not be there if you have an account.
accounts array accounts[] An array of accounts.
accountName string

TRYKE INC

Account name.
accountNumber string 110249 Account number.
accountUcmId string 1000014389 Unique Id of an account. This field is useful for resellers creating a device or adding services on behalf of their customers. 
accountStatus string Active Account status. Possible values: Active, Processing.
referenceID string 921696 This is a temporary ID that can be used to create a device when the account is Pending.
subCustomerAccounts array subCustomerAccounts[] An array of subCustomerAccounts associated with a reseller. 
errorMessage string   Error message.
errorCode string   Error code.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Agreement Status

GET /ne/v1/device/agreement/account

 Method  GET
 URL or End Point  /ne/v1/device/agreement/account
 Headers  Authorization, Content-Type
 Query Parameters  account_number
 Body  Not applicable

 

Checks the validity of a customer's agreement. In case the agreement is not signed or not valid, this API will return the agreement terms. 

 

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

 

Sample curl request:

curl -X

GET "https://api.equinix.com/ne/v1/device/agreement/account?account_number=2252619"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameter:

Query Parameter Name Mandatory Type Example Applicable Values Description
account_number Yes string 2252619   Customer's account number.

 

 

Sample response:

{
    "termsVersionID": "",
    "terms": "",
    "isValid": "true",
    "errorMessage": ""
}

 

 

The description of the response payload:

Field name Type Example Description
termsVersionID string a2Z34000002CXRtEAO Version Id of the agreement. You will only see a version ID if you have not signed an agreement or your agreement is not valid.  
terms string EQUINIX NETWORK EDGE SERVICES TRIAL AGREEMENT\r\n\r\nThis Equinix Network Edge Services Trial Agreement (this “Agreement”) is made and entered into by and between Equinix, Inc. (“Equinix,” “Us” or “We”) and you, our customer (“Customer”).  The terms of the agreement. You will only get the terms if you have not signed an agreement or the agreement is not valid.
isValid string

True

True if the agreement is valid, false if it is not.
errorMessage string   Error message.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

POST Agreement

POST /ne/v1/device/agreement/account

 Method  POST
 URL or End Point  /ne/v1/device/agreement/account
 Headers  Authorization, Content-Type
 Path Parameters  NA
 Body Parameters  accountNumber, apttusId

 

Posts the agreement between you and Network Edge.

 

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

 

Sample curl request:

curl -X

POST "https://api.equinix.com/ne/v1/device/agreement/account"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d "{
"accountNumber": "V74191621",

"apttusId": "a2Z34000002CXRtEAO"

}"

 

Body parameters:

Parameter Name Mandatory Type Example Applicable Values Description
accountNumber Yes string 8907778

 

Customer's account number.
apttusId Yes string a2Z34000002CXRtEAO   The version number of the agreement.

 

{
    "status": "PROCESSED"
}

 

Response payload:

Field Type Example Values Description
status string PROCESSED The agreement request is being processed.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Vendor Terms

GET ne/v1/device/agreement/vendor

 Method  GET
 URL or End Point  ne/v1/device/agreement/vendor
 Headers  Authorization, Content-Type
 Query Parameters  vendorPackage, licenseType
 Body  Not applicable

 

Returns a link to the terms of the vendor of your virtual device. 

 

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

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/device/agreement/vendor?vendorPackage=CSR1000V&licenseType=SUB"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
vendorPackage Yes string

CSR1000V

 

Vendor package. This code specifies the device type (firewall, router, or SDWAN device) you want. 
licenseType Yes string SUB SUB, BYOL License type, whether subscription (SUB) or bring your own license (BYOL). 

 

Sample response:

{
  "terms": "https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html"
}

 

The description of the response payload:

Field  Name Type Example Description
terms string

https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html

A link to the vendor terms. 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Order Terms

GET ne/v1/device/agreement/order

 Method  GET
 URL or End Point  ne/v1/device/agreement/order
 Headers  Authorization, Content-Type
 Path Parameter  Not applicable
 Body  Not applicable

 

Returns the order and vendor-specific terms and conditions. 

 

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

 

Sample curl request. 

curl -X

GET "https://api.equinix.com/ne/v1/device/agreement/order"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Sample response:

{
    "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\").\r\n\r\nUnless 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).\r\n\r\nThe 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. \r\n\r\nFor 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.\r\n\r\nIf you have any questions regarding the terms of this Order, please contact your Equinix Sales Representative.\r\n\r\n\r\n \r\nATTACHMENT A \r\nPRODUCT PROVIDER EULA"
}

 

The description of the response payload is as follows:

Field  Name Type Example Description
terms string 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 Equinix order terms and conditions.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Price

GET /ne/v1/device/price

 Method  GET
 URL or End Point  /ne/v1/device/price
 Headers  Authorization, Content-Type
 Query Parameters  accountNumber, metro, vendorPackage, licenseType, softwarePackage, throughput, throughputUnit, termLength,  additionalBandwidth,  deviceManagementType, core, secondaryAccountNumber, secondaryMetro, secondaryAdditionalBandwidth, accountUcmId
 Body  Not applicable

 

Returns the price of a virtual device or the price of additional services for an existing virtual device. You can use this API to get the prices of both the primary and secondary devices. Note: If you are a reseller's customer, please contact your reseller for pricing information.

 

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

 

 Sample curl request:

curl -X

GET "https://api.equinix.com/ne/v1/device/price?accountNumber=200541&metro=SV&vendorPackage=CSR1000V&licenseType=SUB&softwarePackage=AX&throughput=1&throughputUnit=Gpbs&termLength=1&virtualDeviceUUID=99e429f4-c9dc-427c-812e-6b368b94755e&core=4&deviceManagementType=EQUINIX-CONFIGURED&addtionalBandwidth=200"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountNumber Yes integer 2252726   Account number. Please enter the account number that belongs to the metro where you want a device. 
metro Yes string DC   Metro code.
vendorPackage Yes string CSR1000V   Vendor package (device type code). 
licenseType Yes string SUB  

License type, whether you want a subscription license (Equinix handles the license and charges monthly) or you want to bring your own license (BYOL). 

softwarePackage Yes string IPBASE   Software package code. 
throughput   string 500   Throughput. 
throughputUnit   string Mbps   Throughput Unit.
termLength Yes string 1   The term length of the contract in months. Default = 1 month.
additionalBandwidth   integer 100   Additional bandwidth (in Mbps).
deviceManagementType Yes string EQUINIX-CONFIGURED EQUINIX-CONFIGURED, SELF-CONFIGURED Whether the device is managed by Equinix or not. 
core Yes integer 4   The number of cores.
virtualDeviceUUID   string

d5d88982-382f-420a-8d63-9dc4c3075f4c

  Unique ID of a virtual device. You may query this API to check the price of additional services for an existing virtual device. 
secondaryAccountNumber   integer 2242345   Secondary account number of an HA (high availability) device. Please provide a secondary account number to get the price of your secondary device.
secondaryMetro   string DC   Secondary metro for an HA (high availability) device. Please provide a second metro location to get the price of your secondary device. 
secondaryAdditionalBandwidth   integer 100   Secondary additional bandwidth of an HA (high availability) device in Mbps.
accountUcmId   string 678907   Unique Id of your account. You may use this unique Id if you do not have an account number.

 

Sample response:

{
    "termLength": "12",
    "primary": {
        "charges": [
            {
                "description": "VIRTUAL_DEVICE",
                "monthlyRecurringCharges": "423.20"
            },
            {
                "description": "DEVICE_LICENSE",
                "monthlyRecurringCharges": "0.00"
            },
            {
                "description": "ADDITIONAL_BANDWIDTH",
                "monthlyRecurringCharges": "1932.00"
            }
        ],
        "currency": "USD",

        "billingCommencementDate": "Wed Feb 12 2020 20:47:26 UTC"
    },
    "secondary": {
        "charges": [
            {
                "description": "VIRTUAL_DEVICE",
                "monthlyRecurringCharges": "423.20"
            },
            {
                "description": "DEVICE_LICENSE",
                "monthlyRecurringCharges": "0.00"
            },
            {
                "description": "ADDITIONAL_BANDWIDTH",
                "monthlyRecurringCharges": "1288.00"
            }
        ],
        "currency": "USD",

        "billingCommencementDate": "Wed Feb 12 2020 20:47:26 UTC"
    }
}

 

The description of the response payload is as follows:

Field Name Type Example Description
termLength string 1 The term length of the contract. 
primary object primary{} Price details of the primary device.
charges array charges[] Array of charges.
description string VIRTUAL_DEVICE Description of the charge, whether it is for a virtual device, device license, or additional bandwidth. 
monthlyRecurringCharges string 566 Monthly charges.
currency string USD Currency.
billingCommencementDate string

"Wed Feb 12 2020 20:47:26 UTC"

Your billing will start on this date.
secondary object secondary{} Price details of the secondary object, in case you want a secondary object for high availability.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Order Summary

GET /ne/v1/device/order-summary

 Method  GET
 URL or End Point  /ne/v1/device/order-summary
 Headers  Authorization, Content-Type
 Query Parameters  accountNumber, metro, vendorPackage, licenseType, softwarePackage,   throughput, throughputUnit, termLength,  additionalBandwidth,   virtualDeviceUUID, core, deviceManagementType, secondaryAccountNumber, secondaryMetro, secondaryAdditionalBandwidth, accountUcmId
 Body  Not applicable

 

Returns the Equinix order summary as a printable pdf file. This API provides an order estimate to help you go through the PO process before making a purchase. 

Note: If you are a reseller's customer, please contact your reseller for pricing information.

 

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

 

Sample curl request: 

curl -X

GET "https://api.equinix.com/ne/v1/device/order-summary?accountNumber=200541&vendorPackage=CSR1000V&metro=SV&licenseType=SUB&softwarePackage=SEC&throughput=1&throughputUnit=Gbps&termLength=1&additionalBandwidth=200&core=4&deviceManagementType=EQUINIX-CONFIGURED"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Query parameters:

Query Parameter Name Mandatory Type Example Applicable Values Description
accountNumber Yes integer 2252726   Account number. Please provide an account number that belongs to the metro where you want a device.
metro Yes string DC   Metro where you want a device.
vendorPackage Yes string CSR1000V   Vendor package (device type code).
licenseType   string SUB  

License type, whether you want a subscription license (Equinix handles the license and charges monthly) or you want to bring your own license (BYOL).

softwarePackage Yes string IPBASE   Software package code.
throughput Yes string 500   Throughput of the device.
throughputUnit Yes string Mbps   Throughput Unit.
termLength   string 1   The term length of the contract in months.
additionalBandwidth   integer 100   Additional bandwidth (in Mbps).
deviceManagementType   string EQUINIX-CONFIGURED EQUINIX-CONFIGURED, SELF-CONFIGURED Whether the device is managed by Equinix or not. 
core   integer 4   The number of cores.
virtualDeviceUUID   string

d5d88982-382f-420a-8d63-9dc4c3075f4c

  Unique ID of a virtual device. You may query this API to check the price of additional services for an existing virtual device. 
secondaryAccountNumber   integer 2242345   Secondary account number of an HA (high availability) device.
secondaryMetro   string DC   Secondary metro of an HA (high availability) device.
secondaryAdditionalBandwidth   integer 100   Secondary additional bandwidth of an HA (high availability) device in Mbps.
accountUcmId   string 678907   Unique Id of your account. You may use this unique Id if you do not have an account number.

 

Sample response:

200 Okay

 

The description of the response is as follows:

Parameter Description
Content-Type application/pdf;charset=UTF-8. The response is a pdf file that you can save or view online. 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.