Skip to content
Cloudflare API
Start here
API Reference
Network Interconnects
Interconnects

List existing interconnects

client.networkInterconnects.interconnects.list(InterconnectListParams { account_id, cursor, limit, 2 more } params, RequestOptionsoptions?): InterconnectListResponse { items, next }
GET/accounts/{account_id}/cni/interconnects

List existing interconnects

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Magic WAN WriteMagic WAN ReadMagic Transit ReadMagic Transit Write
ParametersExpand Collapse
params: InterconnectListParams { account_id, cursor, limit, 2 more }
account_id: string

Path param: Customer account tag

cursor?: number | null

Query param

formatint32
limit?: number | null

Query param

minimum0
site?: string | null

Query param: If specified, only show interconnects located at the given site

type?: string | null

Query param: If specified, only show interconnects of the given type

ReturnsExpand Collapse
InterconnectListResponse { items, next }
items: Array<NscInterconnectPhysicalBody { account, facility, name, 5 more } | NscInterconnectGcpPartnerBody { account, name, region, 3 more } >
One of the following:
NscInterconnectPhysicalBody { account, facility, name, 5 more }
account: string
facility: Facility { address, name }
address: Array<string>
name: string
name: string
site: string

A Cloudflare site name.

slot_id: string
formatuuid
speed: string
type: string
owner?: string
NscInterconnectGcpPartnerBody { account, name, region, 3 more }
account: string
name: string
region: string
type: string
owner?: string
speed?: "50M" | "100M" | "200M" | 9 more

Bandwidth structure as visible through the customer-facing API.

One of the following:
"50M"
"100M"
"200M"
"300M"
"400M"
"500M"
"1G"
"2G"
"5G"
"10G"
"20G"
"50G"

List existing interconnects

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const interconnects = await client.networkInterconnects.interconnects.list({
  account_id: 'account_id',
});

console.log(interconnects.items);
{
  "items": [
    {
      "account": "account",
      "facility": {
        "address": [
          "string"
        ],
        "name": "name"
      },
      "name": "name",
      "site": "site",
      "slot_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "speed": "speed",
      "type": "type",
      "owner": "owner"
    }
  ],
  "next": 0
}
Returns Examples
{
  "items": [
    {
      "account": "account",
      "facility": {
        "address": [
          "string"
        ],
        "name": "name"
      },
      "name": "name",
      "site": "site",
      "slot_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "speed": "speed",
      "type": "type",
      "owner": "owner"
    }
  ],
  "next": 0
}