Network Edge APIs | Equinix Product Documentation

Virtual-Device

APIs for managing the lifecycle and configuration of virtual devices.

Operations

Returns all virtual devices available on the Network Edge platform.

Security

BearerAuth

offsetinteger, (int32)

Specifies where to start a page. It is the starting point of the collection returned from the server.

Default:0

Example:offset=0

limitinteger, (int32)

Specifies the page size.

Default:20

Example:limit=20

metroCodestring

Two-letter metro code.

Example:metroCode=SV

statusstring

The status of the device.

Enum:"PROVISIONED""PROVISIONING""DEPROVISIONED""DEPROVISIONING""FAILED"

Example:status=PROVISIONED

showOnlySubCustomerDevicesboolean

Resellers may mark this Yes to see sub customer devices.

Example:showOnlySubCustomerDevices=false

accountUcmIdstring

Unique ID of the account.

Example:accountUcmId=123456

searchTextstring

Enter text to fetch only matching device names

Example:searchText=My-Device

sortArray of strings

Sorts the output based on field names.

Example:sort=name

projectIdsstring

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

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

Payload

// No request payload

Bodyapplication/json

paginationobject(PaginationResponse)required

dataArray of objects(VirtualDeviceDetailsResponse)required

Array of available virtual devices

Response

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