Patch Panels

Get Patch Panels

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

This API request returns patch panels eligible for ordering Equinix Internet Access.

Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/patchPanels?location.ibx=DC5&account.accountNumber=123456&cage.spaceId=DC5:01:12345_67890&cabinet.spaceId=DC5:01:12345_67890:Demarc'
-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
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:12345_67890
cabinet.spaceId `string` REQUIRED	Cabinet space identifier. Applicable values: Use the Get Cabinets API request to retrieve cabinets eligible for ordering Equinix Internet Access. Example: DC5:01:12345_67890:Demarc
mediaTypes.name `string` OPTIONAL	Media type. Applicable values: SINGLE_MODE_FIBER
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": "CP:Demarc:1266844",
            "customerRefNumber": "ME1:01:040310:0422:RU34:49-72",
            "type": "CUSTOMER_PROVIDED",
            "prewired": false,
            "availablePortsCount": 4,
            "availablePorts": [
                1,
                10,
                100,
                101
            ],
            "ownedPortsCount": 0,
            "ownedPorts": [
                {
                    "number": 1,
                    "ownershipType": "USED",
                    "ownerType": "CROSS_CONNECT",
                    "ownerUuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
                }
            ],
            "mediaTypes": [
                "Single-Mode Fiber",
                "62.5_MICRON_MULTI_MODE_FIBER",
                "OS1",
                "50_MICRON_MULTI_MODE_FIBER_OM3",
                "62.5_MICRON_MULTI_MODE_FIBER_OM1",
                "50_MICRON_MULTI_MODE_FIBER_OM3",
                "50_MICRON_MULTI_MODE_FIBER_OM4"
            ],
            "dedicatedMediaType": "FIBER",
            "cage": {
                "spaceId": "DC5:01:20221219_910222"
            },
            "cabinet": {
                "spaceId": "DC5:01:20221219_910222:Demarc"
            },
            "location": {
                "ibx": "DC5"
            },
            "account": {
                "accountNumber": "123456"
            }
        }
    ]
}

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 patch panels eligible for ordering Equinix Internet Access.
number `string`	Patch panel identifier. Example: CP:Demarc:1266844
customerRefNumber `string`	Customer's reference number. Example: ME1:01:040310:0422:RU34:49-72
type `string`	Patch panel category. Possible values: EQUINIX_PROVIDED CUSTOMER_PROVIDED PREWIRE_PANEL_INFRASTRUCTURE
prewired `boolean`	Indicates if the patch panel has been pre-wired. Example: true
availablePortsCount `integer`	Number of available ports in the patch panel. Example: 4
availablePorts `array[integer]`	List of port numbers that are available.
ownedPortsCount `integer`	Number of ports assigned to customer. Example: 0
ownedPorts `array[object]`	Customer-owned ports information.
number `integer`	Port number. Example: 1
ownershipType `string`	Port ownership status. Possible values: USED RESERVED
ownerType `string`	Product ownership. Possible values: CROSS_CONNECT LOA_REQUEST DIGITAL_LOA NETWORK_PORT METRO_CONNECT OTHER
ownerUuid `string`	Port owner identifier. Example: a867f685-41b0-1b07-6de0-320a5c00abdd
mediaTypes `array[string]`	Available media types. Example: 62.5_MICRON_MULTI_MODE_FIBER
dedicatedMediaType `string`	Dedicated media type. Example: FIBER
cage `object`	Cage information.
spaceId `string`	Cage space identifier. Example: DC5:01:20221219_910222
cabinet `object`	Cabinet information.
spaceId `string`	Cabinet space identifier. Example: DC5:01:20221219_910222:Demarc
location `object`	Patch panel location information.
ibx `string`	IBX data center identifier. Example: DC5
account `object`	Customer account information.
accountNumber `string`	Customer account number. Example: 123456

Get Patch Panels​

Get Patch Panels