Skip to main content
API docs by Redocly

Lookup (2.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order

Lookup

Lookup

Get Locations by permission code

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.

Authorizations:
BearerAuth
query Parameters
permissionCode
required
string
Enum: "CROSS_CONNECT" "WORK_VISIT" "SHIPMENTS"

List of Permission code to be filtered

ibxs
Array of strings

List of IBXs to be filtered

providerAccountNumber
string

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

aSideIbx
string

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

connectionService
string

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.

details
boolean
Default: false

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

Responses

Response Schema: application/json
Array of objects (locations_details)
Array
ibx
string

IBX locations code

accessRestricted
boolean
Default: false

IBX access is restricted when the value is true

specialPrivilege
boolean
Default: false

When set to true, user will be allowed to access IBXs with restricted access. This only applies for specific partners

Array of objects (accounts)
Array of objects (cage_details)

Response samples

Content type
application/json
Example
{
  • "crossConnects": [
    ]
}

Retrieve all patch panels

This method retrieves all available patch panels associated with a cabinet for a user with cross connects ordering permission.

Authorizations:
BearerAuth
query Parameters
cabinetId
required
string

ID of the cabinet

providerAccountNumber
string

The service provider's account number (Z-side) linked to their cage. Mandatory when used together with aSideIbx

aSideIbx
string

The IBX location code for A-Side. When used together with providerAccountNumber, this returns Z-side patch panel details.

accountNumber
string

Account number is only required when cabinet is shared.

Responses

Response Schema: application/json
Array
patchPanelId
string

Patch panel unique ID / serial number

availablePortCount
number

Available ports for use

patchPanelReferenceId
string

Unique reference ID associated with patch panel

ifcEnabled
boolean
Default: false

Patch panel will support only intra facility when true

provisioningType
string
Enum: "REGULAR" "FAST_PROVISIONING"

If REGULAR, order will be provisioned as per standard lead time. If FAST_PROVISIONING, order is typically provisioned in 30min through the support of fast provisioning scheduling. However, service may be delayed due to system maintenance

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve patch panel details

This method retrieves details of a patch panel by its ID to a user with cross connects ordering permission.

Authorizations:
BearerAuth
path Parameters
patchPanelId
required
string

ID of patch panel

query Parameters
providerAccountNumber
string

The service provider's account number (Z-side) linked to their cage. Mandatory when used together with aSideIbx

aSideIbx
string

The IBX location code for A-Side. When used together with providerAccountNumber and accountNumber, this returns Z-side patch panel details.

accountNumber
string

A-Side cage account number

Responses

Response Schema: application/json
patchPanelId
string

Patch panel ID / serial number

ibx
string

IBX location code

cageId
string

Cage ID

cabinetId
string

Cabinet ID

accountNumber
string

Customer cage account number

accountName
string

Customer cage account name

dedicatedMediaType
string

Type of dedicated media

preWired
boolean

Prewired status of cross connects. When true, cross connects are prewired

type
string
Enum: "CUSTOMER_PROVIDED" "EQUINIX_PROVIDED"

Patch panel type

ifcEnabled
boolean

Identifies if intra-facility cable (IFC) connection is required for patch panel. When true, IFC connection is required.

rackLocations
string

Rack location of patch panel

installLocations
string
Value: "STANDARD"

Location of installed patch panel

installationRequired
boolean
Default: false

If true, Equinix will install cross connect from demarcation panel to customer equipment.

circuitAvailable
boolean
Default: false

if true, circuits are available for patch panel

availablePorts
Array of numbers

Individually identified ports that are available out of the total number of ports.

Array of objects (Connection_services_details)
Array
name
string (Connection_services)
Enum: "COAX" "MP4_CABLE" "MULTI_MODE_FIBER" "POTS" "SINGLE_MODE_FIBER" "UTP"

The name of the available connection service.

Array of objects
Array of objects (userPortDetails)
Array
portNumber
number

Port number that is currently in use

serialNumber
string

Serial number or cable id

connectionServicesName
string (Connection_services)
Enum: "COAX" "MP4_CABLE" "MULTI_MODE_FIBER" "POTS" "SINGLE_MODE_FIBER" "UTP"

The name of the available connection service.

zSideProviderName
string

Name of Z-Side service provider

circuitId
string
provisioningType
string
Enum: "REGULAR" "FAST_PROVISIONING"

If REGULAR, order will be provisioned as per standard lead time. If FAST_PROVISIONING, order is typically provisioned in 30min through the support of fast provisioning scheduling. However, service may be delayed due to system maintenance

Response samples

Content type
application/json
{
  • "ibx": "IB1",
  • "cageId": "IB1:04:144155",
  • "accountName": "COMPANY INC.",
  • "accountNumber": "101323",
  • "patchPanelId": "PP:0000:31231",
  • "cabinetId": "PP:0000:31231:0000",
  • "prewired": false,
  • "maxPorts": 48,
  • "type": "Customer provided",
  • "customerReferenceId": "IFC DEMARC",
  • "ifcPanel": false,
  • "availablePorts": [
    ],
  • "connectionServices": [
    ]
}

Retrieve list of providers

This method retrieves all available cross connect service providers to a user with cross connects ordering permission.

Authorizations:
BearerAuth
query Parameters
cageId
required
string

Cage ID

accountNumber
required
string

Account number of A-Side cage

Responses

Response Schema: application/json
Array
providerAccountName
string

Cage account name of service provider

providerAccountNumber
string

Cage account number of service provider

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve list of connection services

This method retrieves a list of supported connection services such as media types, protocol types, connector types and circuit counts.

Authorizations:
BearerAuth
query Parameters
ibx
required
string

IBX

Responses

Response Schema: application/json
Array
name
string (Connection_services)
Enum: "COAX" "MP4_CABLE" "MULTI_MODE_FIBER" "POTS" "SINGLE_MODE_FIBER" "UTP"

The name of the available connection service.

Array of objects
Array
name
string (media_types)
Enum: "COAX" "MP4_CABLE" "50_MICRON_MULTI_MODE_FIBER" "50_MICRON_MULTI_MODE_FIBER_OM2" "50_MICRON_MULTI_MODE_FIBER_OM3" "50_MICRON_MULTI_MODE_FIBER_OM4" "62.5_MICRON_MULTI_MODE_FIBER" "62.5_MICRON_MULTI_MODE_FIBER_OM1" "ABAM" "CAT3" "CAT5E" "CAT6" "CAT6A" "OS1" "SINGLE_MODE_FIBER"

Name of the media type that corresponds with the connection service.

Array of objects
circuitCounts
Array of integers

Intra-Faciltiy Cable (IFC) circuit count options available for the respective connection service. E.g. If the 'circuitCount' is empty, it means there are no available IFC circuits. If '3,6' appears in the circuit count, it means that the IFC circuits options available are 3 circuits and 6 circuits.

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]