Device Link

Get Device Links

	GET /ne/v1/links
Method	GET
URL or End Point	/ne/v1/links
Headers	Authorization, Content-Type
Query Parameters	metro, virtualDeviceUuid, accountUcmId, groupUuid, groupName, offset, limit
Body	Not applicable

Returns device links.

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

A sample curl request.

curl -X
GET "https://api.equinix.com/v1/links"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

Query Parameters	Mandatory	Type	Example	Description
metro	No	string	DA	Metro code.
virtualDeviceUuid	No	string	7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a	Unique Id of a virtual device.
accountUcmId	No	string	6ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6b	Unique Id of the account. A reseller querying for a customer's linking groups can pass the accountUcmId of the customer's account. To get the accountUcmId of your customer's account, please check the Equinix account creation portal (ECP) or call Get account API.
groupUuid	No	string	4cfb5675-5c3f-4275-adba-0c9e3c26c96b	The unique Id of the link group.
groupName	No	string	my-link	The name of the link group.
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.

Sample response:

{

  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1
  },
  "data": [
    "uuid": "8a9b73a2-01ba-4e57-a3a2-a3a105b0b49e",
    "groupName": "test-link",
    "subnet": "10.0.0.0/27",
    "status": "PROVISIONING",
    "createdBy": "nfv-sit5",
    "createdDate": "2021-01-05T01:44:44.924Z",
    "lastUpdatedBy": "nfv-sit5",
    "lastUpdatedDate": "2021-01-05T01:44:44.924Z",
    "redundancyType": "PRIMARY",
    "metroLinks": [
        {
           "accountName": "Samsung",
           "accountNumber": 270218,
           "accountReferenceID": 1234,
           "metroCode": "SV",
           "metroName": "Silicon Valley",
           "throughput": 500,
           "throughputUnit": "Mbps"
        }
     ],
    "linkDevices": [
        {
            "deviceUuid": "d186dc1a-29e7-4829-bb5e-50fa57aca923",
            "deviceName": "CSR-DEMO-3",
            "metroCode": "SY",
            "metroName": "Sydney",
            "deviceTypeCode": "C8000V",
            "category": "ROUTER",
            "ipAssigned": "10.0.0.1/27",
            "interfaceId": 5,
            "status": "PROVISIONING",
            "deviceManagementType": "SELF-CONFIGURED",
            "networkScope": "DEVICE",
            "isDeviceAccessible": true
        },
        {
            "deviceUuid": "ea128600-1875-4f7a-80e9-307a5bbeac51",
            "deviceName": "NEAut-IjvTe-C8000V-SEC",
            "metroCode": "SY",
            "metroName": "Sydney",
            "deviceTypeCode": "C8000V",
            "category": "ROUTER",
            "ipAssigned": "10.0.0.2/27",
            "interfaceId": 5,
            "status": "PROVISIONING",
            "deviceManagementType": "SELF-CONFIGURED",
            "networkScope": "TENANT",
            "isDeviceAccessible": true
          }
      ]
    }
  ]
}

The description of the response payload:

Field	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	Page size.
total	integer	100	The total number of results.
next	string		The next set of records.
previous	string		The previous set of records.
data	array		An array of link objects.
uuid	string	6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567	The unique Id of the linked group.
groupName	string	vik-chain	Group name.
subnet	string	10.0.0.0/27	The subnet of the device linking group.
status	string	PROVISIONING	The status of the device link group.
redundancyType	string	PRIMARY	Whether the connection is created through Fabric's PRIMARY or SECONDARY port. If one connection is through the primary port and the other through the secondary port, then the redundancyType is HYBRID. PRIMARY SECONDARY HYBRID
metroLinks	array		An array of links associated with the linked group.
accountName	string	EQX16B76E96-3161-4f15-86F7-CB871DB2F53C	The account name associated with the link.
metroCode	string	SY	The metro you want to link.
metroName	string	Sydney	The name of the metro you want to link.
throughput	string	200	The throughput of the link.
throughputUnit	string	Mbps	The throughput unit of the link.
linkDevices	array		An array of devices in the link.
deviceUuid	string	9ea5a0e4-2bf7-45c2-9aa7-e846a8cd5560	The unique Id of the device.
deviceName	string	csr-sroy1	The name of the device.
metroCode	string	SY	Metro code.
metroName	string	Sydney	Metro name.
deviceTypeCode	string	C8000V	Device type code.
category	string	ROUTER	The category of the device.
ipAssigned	string	10.0.0.2/27	The assigned IP address of the device.
interfaceId	string	6d5b942a-429e-494e-87e0-993845951cf	The unique Id of the interface used to link the device.
status	string	PROVISIONING	The status of the device.
deviceManagementType	string	SELF-CONFIGURED	Device management type.
createdBy	string	nfv-sit1	Created by username.
createdDate	string	2018-08-30T04:20:36.033Z	Created date.
lastUpdatedBy	string	nfv-sit1	Last updated by.
lastUpdatedDate	string	2018-08-30T04:20:36.033Z	Last update date.

Note: The links array and all the fields associated with it are deprecated and replaced by metroLinks.

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

Get Device Link {uuid}

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

Returns a device link.

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

A sample curl request.

curl -X
GET "https://api.equinix.com/ne/v1/links/7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the path parameter is as follows:

Path Parameter	Mandatory	Type	Example	Applicable Values	Description
uuid	Yes	string	7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a		The unique Id of a device link group.

Sample response:

{
    "uuid": "8a9b73a2-01ba-4e57-a3a2-a3a105b0b49e",
    "groupName": "test-link",
    "subnet": "10.0.0.0/27",
    "status": "PROVISIONING",
    "redundancyType": "PRIMARY",
    "createdBy": "nfv-sit5",
    "createdDate": "2021-01-05T01:44:44.924Z",
    "lastUpdatedBy": "nfv-sit5",
    "lastUpdatedDate": "2021-01-05T01:44:44.924Z",
    "metroLinks": [
        {
             "accountName": "Samsung",
             "accountNumber": 270218,
             "accountReferenceID": 1234,
             "metroCode": "SV",
             "metroName": "Silicon Valley",
             "throughput": 500,
             "throughputUnit": "Mbps"
        }
     ],
    "linkDevices": [
        {
            "deviceUuid": "d186dc1a-29e7-4829-bb5e-50fa57aca923",
            "deviceName": "CSR-DEMO-3",
            "metroCode": "SY",
            "metroName": "Sydney",
            "deviceTypeCode": "C8000V",
            "category": "ROUTER",
            "ipAssigned": "10.0.0.1/27",
            "interfaceId": 5,
            "status": "PROVISIONING",
            "deviceManagementType": "SELF-CONFIGURED",
            "networkScope": "DEVICE",
            "isDeviceAccessible": true
        },
        {
            "deviceUuid": "ea128600-1875-4f7a-80e9-307a5bbeac51",
            "deviceName": "NEAut-IjvTe-C8000V-SEC",
            "metroCode": "SY",
            "metroName": "Sydney",
            "deviceTypeCode": "C8000V",
            "category": "ROUTER",
            "ipAssigned": "10.0.0.2/27",
            "interfaceId": 5,
            "status": "PROVISIONING",
            "deviceManagementType": "SELF-CONFIGURED",
            "networkScope": "TENANT",
            "isDeviceAccessible": true
        }
    ] 
}

The description of the response payload is as follows:

Field	Type	Example Values	Description
uuid	string	6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567	The unique Id of the linked group.
groupName	string	vik-chain	The group name.
subnet	string	10.0.0.0/27	The subnet of the device linking group.
status	string	PROVISIONING	The status of the device link group.
redundancyType	string	PRIMARY	Whether the connection is created through Fabric's PRIMARY or SECONDARY port. If one connection is through the primary port and the other through the secondary port, then the redundancyType is HYBRID. PRIMARY SECONDARY HYBRID
metroLinks	array		An array of links associated with the linked group.
accountName	string	EQX16B76E96-3161-4f15-86F7-CB871DB2F53C	The account name associated with the link.
metroCode	string	SY	The metro you want to link.
metroName	string	Sydney	The name of the metro you want to link.
throughput	string	200	The throughput of the link.
throughputUnit	string	Mbps	The throughput unit of the link.
linkDevices	array		An array of devices in the link.
deviceUuid	string	9ea5a0e4-2bf7-45c2-9aa7-e846a8cd5560	The unique Id of a device.
deviceName	string	csr-sroy1	The name of the device.
metroCode	string	SY	Metro code.
metroName	string	Sydney	Metro name.
deviceTypeCode	string	C8000V	Device type code.
category	string	ROUTER	The category of the device.
ipAssigned	string	10.0.0.2/27	The assigned IP address of the device.
interfaceId	string	6d5b942a-429e-494e-87e0-993845951cf	The unique Id of the interface used to link the device.
status	string	PROVISIONING	The status of the device.
deviceManagementType	string	SELF-CONFIGURED	Device management type.
createdBy	string	nfv-sit1	Created by username.
createdDate	string	2018-08-30T04:20:36.033Z	Created date.
lastUpdatedBy	string	nfv-sit1	Last updated by.
lastUpdatedDate	string	2018-08-30T04:20:36.033Z	Last update date.

Note: The links array and all the fields associated with it are deprecated and replaced by metroLinks array.

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

Update Device Link

	PATCH /ne/v1/links/{uuid}
Method	PATCH
URL or End Point	/ne/v1/links/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Body Parameters	groupName, subnet, redundancyType, linkDevices[deviceUuid, asn, interfaceId], metroLinks[ {accountNumber, throughput, throughputUnit, metroCode}]

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

A sample curl request to update a link.

curl -X
PATCH "https://api.equinix.com/ne/v1/links/d186dc1a-29e7-4829-bb5e-50fa57aca923"
-H "content-type: application/json"
-H "Authorization: Bearer jnSoUKaJHpzMnU0toROpUHmqnwEP"
-d '{
  "groupName": "test-link",
  "subnet": "10.0.0.0/27",
  "redundancyType": "SECONDARY",
  "linkDevices": [
    {
      "deviceUuid": "d186dc1a-29e7-4829-bb5e-50fa57aca923",
      "asn": 65414,
      "interfaceId": 6
    },
    {
      "deviceUuid": "ea128600-1875-4f7a-80e9-307a5bbeac51",
      "asn": 100,
      "interfaceId": 6
    }
  ],
  "metroLinks": [
    {
      "accountNumber": "2393479",
      "throughput": "200",
      "throughputUnit": "Mbps",
      "metroCode": "SY"
    }
  ]

}'

Path parameter:

Path Parameter Name	Mandatory	Type	Example	Applicable Values	Description
uuid	Yes	string	6953b3d7-713d-4412-b6d7-0c5fc5e2a800		The unique Id a device link.

The description of the body parameters is as follows:

Body Parameter Name	Mandatory	Type	Example	Description
groupName	Yes	string	vik-chain	Group name.
subnet		string	10.0.0.0/27	The subnet of the link group.
redundancyType		string	SECONDARY	Whether you want to create connection through Fabric's primary or secondary port. Possible Values: PRIMARY SECONDARY
linkDevices	Yes	array		An array of devices you wish to link.
deviceUuid	Yes	string	d186dc1a-29e7-4829-bb5e-50fa57aca923	The unique Id of a device you wish to link.
asn	No	integer	25678	ASN number. The request will fail if you provide a new ASN for a device that already has an ASN.
interfaceId	No	integer	6	Any available device interface. Equinix will select an interface if you do not provide one.
metroLinks	No	array		An array of links to be created/updated.
accountNumber	No	string	2393478	Account number. You may provide the account number of either the source or the destination metro.
throughput	No	string	500	Throughput.
throughputUnit	No	string	Mbps	Throughput unit.
metroCode	No	string	SY	The metro you want to link.

Response payload:

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

Delete Device Link

	DELETE /ne/v1/links/{uuid}
Method	DELETE
URL or End Point	/ne/v1/links/{uuid}
Headers	Authorization, Content-Type
Query Parameter	NA
Path Parameter	Unique Id of a device link group
Body	NA

Deletes a device link group.

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

A sample curl request to delete a device linking group.

curl -X
DELETE "https://api.equinix.com/ne/v1/links/5f888d91-d2c5-45bb-9b51-fed99f57f0ac"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

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

Sample response:

204: No Content

The description of the response is as follows:

HTTP status	Description
204	The request was successfully processed.

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

Get Device Links​

Get Device Link {uuid}​

Update Device Link​

Delete Device Link​

Get Device Links

Get Device Link {uuid}

Update Device Link

Delete Device Link