Cages

Get Cages

GET /internetAccess/v1/cages
Method GET
Endpoint /internetAccess/v1/cages
Headers Authorization
Path Parameters Not applicable
Query Parameters location.ibx, account.accountNumber, offset, limit
Body Parameters Not applicable

This API request returns cages eligible for ordering Equinix Internet Access.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/internetAccess/v1/cages?location.ibx=DC5&account.accountNumber=123456'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
location.ibx string
REQUIRED		 IBX data center identifier.
Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available.
Example: DC5
account.accountNumber string
REQUIRED		 Account number.
Applicable values: Use the Get Accounts API request to retrieve accounts that are available for Equinix Internet Access ordering in a given IBX data center.
Example: 123456
offset integer
OPTIONAL		 Index of the first item returned in the response.
Default value: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Default value: 50

Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1
    },
    "data": [
        {
            "number": "20221219_910222",
            "spaceId": "DC5:01:20221219_910222",
            "cabinetsCount": 2,
            "account": {
                "accountNumber": "123456"
            },
            "location": {
                "ibx": "DC5"
            }
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Data set pagination information.
offset int64
 Index of the first item returned in the response.
limit int64
 Maximum number of items returned per page.
total int64
 Total number of items.
data array[object]
 Data set containing colocation cages with infrastructure eligible for ordering Equinix Internet Access service.
number string
 Cage identifier.
Example: 20221219_910222
spaceId string
 Cage space identifier.
Example: DC5:01:20221219_910222
cabinetsCount integer
 Number of cabinets in the cage eligible for ordering Equinix Internet Access service.
Example: 2
account object
 Customer account information.
accountNumber string
 Customer account number.
Example: 123456
location object
 Asset location information.
ibx string
 IBX data center identifier.
Example: DC5