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

List existing CNI objects

GET/accounts/{account_id}/cni/cnis

Lists all Cloud Network Interconnects (CNIs) configured for the account, showing connection status and parameters.

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
Path ParametersExpand Collapse
account_id: string

Customer account tag

Query ParametersExpand Collapse
cursor: optional number
formatint32
limit: optional number
minimum0
slot: optional string

If specified, only show CNIs associated with the specified slot

tunnel_id: optional string

If specified, only show cnis associated with the specified tunnel id

ReturnsExpand Collapse
items: array of object { id, account, cust_ip, 5 more }
id: string
formatuuid
account: string

Customer account tag

cust_ip: string

Customer end of the point-to-point link

This should always be inside the same prefix as p2p_ip.

formatA.B.C.D/N
interconnect: string

Interconnect identifier hosting this CNI

magic: object { conduit_name, description, mtu }
conduit_name: string
description: string
mtu: number
formatint32
minimum0
p2p_ip: string

Cloudflare end of the point-to-point link

formatA.B.C.D/N
bgp: optional object { customer_asn, extra_prefixes, md5_key }
customer_asn: number

ASN used on the customer end of the BGP session

formatint32
minimum0
extra_prefixes: array of string

Extra set of static prefixes to advertise to the customer’s end of the session

md5_key: optional string

MD5 key to use for session authentication.

Note that this is not a security measure. MD5 is not a valid security mechanism, and the key is not treated as a secret value. This is only supported for preventing misconfiguration, not for defending against malicious attacks.

The MD5 key, if set, must be of non-zero length and consist only of the following types of character:

  • ASCII alphanumerics: [a-zA-Z0-9]
  • Special characters in the set '!@#$%^&*()+[]{}<>/.,;:_-~= |`

In other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A), quotation mark ("), vertical tab (0x0B), carriage return (0x0D), tab (0x09), form feed (0x0C), and the question mark (?). Requests specifying an MD5 key with one or more of these disallowed characters will be rejected.

bgp_mode: optional "dynamic_route_exchange" or "advertise_only"

The BGP mode for a CNI.

Controls the customer-facing data path:

  • DynamicRouteExchange — Full BGP: routes flow through to conduit via CRE / bgp-bridge / bgp-bridge-receiver.
  • AdvertiseOnly — static advertisement via taserver, no routes exchanged with Conduit
One of the following:
"dynamic_route_exchange"
"advertise_only"

List existing CNI objects

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/cni/cnis \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account": "account",
      "cust_ip": "192.168.3.4/31",
      "interconnect": "interconnect",
      "magic": {
        "conduit_name": "conduit_name",
        "description": "description",
        "mtu": 0
      },
      "p2p_ip": "192.168.3.4/31",
      "bgp": {
        "customer_asn": 0,
        "extra_prefixes": [
          "string"
        ],
        "md5_key": "md5_key"
      },
      "bgp_mode": "dynamic_route_exchange"
    }
  ],
  "next": 0
}
Returns Examples
{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account": "account",
      "cust_ip": "192.168.3.4/31",
      "interconnect": "interconnect",
      "magic": {
        "conduit_name": "conduit_name",
        "description": "description",
        "mtu": 0
      },
      "p2p_ip": "192.168.3.4/31",
      "bgp": {
        "customer_asn": 0,
        "extra_prefixes": [
          "string"
        ],
        "md5_key": "md5_key"
      },
      "bgp_mode": "dynamic_route_exchange"
    }
  ],
  "next": 0
}