Network Edge APIs | Equinix Product Documentation

Device-Link-Groups-and-Connections

APIs for managing device link groups and connections between virtual devices.

Operations

This method returns device links. You can link any two or more devices that are registered and provisioned.

Security

BearerAuth

projectIdsstring

If projectIds are different from default projectIds, must pass a projectIds parameter

Example:projectIds=3da0a663-20d9-4b8f-8c5d-d5cf706840c8

metrostring

Metro Code

Example:metro=SV

virtualDeviceUuidstring

Unique Id of a virtual device.

Example:virtualDeviceUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8

accountUcmIdstring

Unique Id of the account. A reseller querying for a customer's link groups can pass the accountUcmId of the customer's account.

Example:accountUcmId=92D27009-EA33-4b60-B4FB-D3C4ED589649

groupUuidstring

Unique Id of a link group

Example:groupUuid=3da0a663-20d9-4b8f-8c5d-d5cf706840c8

groupNamestring

The name of a link group

Example:groupName=linkGroup

offsetinteger, (int32)

Specifies where to start a page.

Default:0

Example:offset=0

limitinteger, (int32)

Specifies the page size.

Default:20

Example:limit=20

Payload

// No request payload

Bodyapplication/json

paginationobject(PaginationResponse)required

dataArray of objects(DeviceLinkGroup)required

Array of available links

Response

{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1
  },
  "data": [
    { … }
  ]
}