Skip to content
Cloudflare API
Start here
API Reference
Network Interconnects

CNIs

List existing CNI objects
network_interconnects.cnis.list(CNIListParams**kwargs) -> CNIListResponse
GET/accounts/{account_id}/cni/cnis
Get information about a CNI object
network_interconnects.cnis.get(strcni, CNIGetParams**kwargs) -> CNIGetResponse
GET/accounts/{account_id}/cni/cnis/{cni}
Create a new CNI object
network_interconnects.cnis.create(CNICreateParams**kwargs) -> CNICreateResponse
POST/accounts/{account_id}/cni/cnis
Modify stored information about a CNI object
network_interconnects.cnis.update(strcni, CNIUpdateParams**kwargs) -> CNIUpdateResponse
PUT/accounts/{account_id}/cni/cnis/{cni}
Delete a specified CNI object
network_interconnects.cnis.delete(strcni, CNIDeleteParams**kwargs)
DELETE/accounts/{account_id}/cni/cnis/{cni}
ModelsExpand Collapse
class CNIListResponse: …
items: List[Item]
id: str
formatuuid
account: str

Customer account tag

cust_ip: str

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: str

Interconnect identifier hosting this CNI

magic: ItemMagic
conduit_name: str
description: str
mtu: int
formatint32
minimum0
p2p_ip: str

Cloudflare end of the point-to-point link

formatA.B.C.D/N
bgp: Optional[ItemBGP]
customer_asn: int

ASN used on the customer end of the BGP session

formatint32
minimum0
extra_prefixes: List[str]

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

md5_key: Optional[str]

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.

class CNIGetResponse: …
id: str
formatuuid
account: str

Customer account tag

cust_ip: str

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: str

Interconnect identifier hosting this CNI

magic: Magic
conduit_name: str
description: str
mtu: int
formatint32
minimum0
p2p_ip: str

Cloudflare end of the point-to-point link

formatA.B.C.D/N
bgp: Optional[BGP]
customer_asn: int

ASN used on the customer end of the BGP session

formatint32
minimum0
extra_prefixes: List[str]

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

md5_key: Optional[str]

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.

class CNICreateResponse: …
id: str
formatuuid
account: str

Customer account tag

cust_ip: str

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: str

Interconnect identifier hosting this CNI

magic: Magic
conduit_name: str
description: str
mtu: int
formatint32
minimum0
p2p_ip: str

Cloudflare end of the point-to-point link

formatA.B.C.D/N
bgp: Optional[BGP]
customer_asn: int

ASN used on the customer end of the BGP session

formatint32
minimum0
extra_prefixes: List[str]

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

md5_key: Optional[str]

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.

class CNIUpdateResponse: …
id: str
formatuuid
account: str

Customer account tag

cust_ip: str

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: str

Interconnect identifier hosting this CNI

magic: Magic
conduit_name: str
description: str
mtu: int
formatint32
minimum0
p2p_ip: str

Cloudflare end of the point-to-point link

formatA.B.C.D/N
bgp: Optional[BGP]
customer_asn: int

ASN used on the customer end of the BGP session

formatint32
minimum0
extra_prefixes: List[str]

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

md5_key: Optional[str]

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.