Network Edge APIs | Equinix Product Documentation

List Accounts by Metro

Request

Gets accounts by metro. You must have an account in a metro to create a virtual device there. To create an account go to "accountCreateUrl".

Security

BearerAuth

Path

metrostringrequired

Metro region for which you want to check your account status

Example:SV

Query

accountUcmIdstring

Unique ID of an account

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

Payload

// No request payload

Responses

Successfully retrieved the account details

Bodyapplication/json

accountCreateUrlstring

The URL to create a new account

Example:"https://customerportal.equinix.com"

dataArray of objects(MetroAccountResponse)

List of metro accounts

errorMessagestring

Error message

Example:"Invalid input"

errorCodestring

Error code

Example:"EQ-4001530"

paginationobject(PaginationResponse)

Response

{
  "accountCreateUrl": "https://customerportal.equinix.com",
  "data": [
    { … }
  ],
  "errorMessage": "Invalid input",
  "errorCode": "EQ-4001530",
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1
  }
}