Lookup | Equinix Product Documentation

Get Locations by permission code

Request

This method retrieves all the user’s IBX locations, accounts, cages and cabinets information according to their ordering permission. This includes A-side and Z-side location information for a cross connect order.

Security

BearerAuth

Query

permissionCodestringrequired

List of Permission code to be filtered

Enum:"CROSS_CONNECT""WORK_VISIT""SHIPMENTS"

ibxsArray of strings

List of IBXs to be filtered

providerAccountNumberstring

The service provider's account number (Z-side) linked to their cage. Mandatory when used together with aSideIbx. This is only applicable when permissionCode is CROSS_CONNECT

aSideIbxstring

A-Side IBX details to fetch the (Z-side). This is only applicable when permissionCode is CROSS_CONNECT

connectionServicestring

Type of connection service to fetch the Z-side details. This is only applicable when permissionCode is CROSS_CONNECT and is required when searching for zSide details.

detailsboolean

When true, API response returns cage, cabinet and account details

Default:false

Payload

// No request payload

Responses

Ok

Bodyapplication/json

crossConnectsArray of objects(locations_details)

Response

{
  "crossConnects": [
    { … }
  ]
}