Cabinets

Get Cabinets

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

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

Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/cabinets?location.ibx=DC5&account.accountNumber=123456&cage.spaceId=DC5:01:20221219_910222'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter	Description
cage.spaceId string REQUIRED	Cage space identifier. Applicable values: Use the Get Cages API request to retrieve cages eligible for ordering Equinix Internet Access. Example: DC5:01:20221219_910222
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

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1
    },
    "data": [
        {
            "number": "Demarc",
            "spaceId": "DC5:01:20221219_910222:Demarc",
            "patchPanelsCount": 7,
            "account": {
                "accountNumber": "123456"
            },
            "cage": {
                "spaceId": "DC5:01:20221219_910222"
            },
            "location": {
                "ibx": "DC5"
            }
        }
    ]
}

Response payload body description

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