{
  "opencollection": "1.0.0",
  "info": {
    "name": "Equinix API Authentication Lookup API",
    "version": "1.2"
  },
  "items": [
    {
      "info": {
        "name": "Lookup",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Locations by permission code",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/colocations/v2/locations",
            "params": [
              {
                "name": "permissionCode",
                "value": "",
                "type": "query",
                "description": "List of Permission code to be filtered"
              },
              {
                "name": "ibxs",
                "value": "",
                "type": "query",
                "description": "List of IBXs to be filtered"
              },
              {
                "name": "providerAccountNumber",
                "value": "",
                "type": "query",
                "description": "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`"
              },
              {
                "name": "aSideIbx",
                "value": "",
                "type": "query",
                "description": "A-Side IBX details to fetch the (Z-side). This is only applicable when permissionCode is `CROSS_CONNECT`"
              },
              {
                "name": "connectionService",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "details",
                "value": "",
                "type": "query",
                "description": "When `true`, API response returns cage, cabinet and account details"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Retrieve all patch panels",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/colocations/v2/patchPanels",
            "params": [
              {
                "name": "cabinetId",
                "value": "",
                "type": "query",
                "description": "ID of the cabinet"
              },
              {
                "name": "providerAccountNumber",
                "value": "",
                "type": "query",
                "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`"
              },
              {
                "name": "aSideIbx",
                "value": "",
                "type": "query",
                "description": "The IBX location code for A-Side. When used together with `providerAccountNumber`, this returns Z-side patch panel details."
              },
              {
                "name": "accountNumber",
                "value": "",
                "type": "query",
                "description": "Account number is only required when cabinet is shared."
              }
            ]
          },
          "docs": "This method retrieves all available patch panels associated with a cabinet for a user with cross connects ordering permission."
        },
        {
          "info": {
            "name": "Retrieve patch panel details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/colocations/v2/patchPanels/:patchPanelId",
            "params": [
              {
                "name": "patchPanelId",
                "value": "",
                "type": "path",
                "description": "ID of patch panel"
              },
              {
                "name": "providerAccountNumber",
                "value": "",
                "type": "query",
                "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`"
              },
              {
                "name": "aSideIbx",
                "value": "",
                "type": "query",
                "description": "The IBX location code for A-Side. When used together with `providerAccountNumber` and `accountNumber`, this returns Z-side patch panel details."
              },
              {
                "name": "accountNumber",
                "value": "",
                "type": "query",
                "description": "A-Side cage account number"
              }
            ]
          },
          "docs": "This method retrieves details of a patch panel by its ID to a user with cross connects ordering permission."
        },
        {
          "info": {
            "name": "Retrieve list of providers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/colocations/v2/providers",
            "params": [
              {
                "name": "cageId",
                "value": "",
                "type": "query",
                "description": "Cage ID"
              },
              {
                "name": "accountNumber",
                "value": "",
                "type": "query",
                "description": "Account number of A-Side cage"
              }
            ]
          },
          "docs": "This method retrieves all available cross connect service providers to a user with cross connects ordering permission."
        },
        {
          "info": {
            "name": "Retrieve list of connection services",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/colocations/v2/connectionServices",
            "params": [
              {
                "name": "ibx",
                "value": "",
                "type": "query",
                "description": "IBX"
              }
            ]
          },
          "docs": "This method retrieves a list of supported connection services such as media types, protocol types, connector types and circuit counts."
        }
      ]
    }
  ],
  "bundled": true
}