Source from repo
Cloudflare Platform Skill

Comprehensive Cloudflare platform skill covering Workers, D1, R2, KV, AI, Durable Objects, and security.
cloudflareGitHub cloudflareSource repo Original GitHub link Publisher page
Files
321
Skill
n/a
Size
1.4 MB
Entrypoint
SKILL.md
Format
git-repo
Open file
references/network-interconnect/api.md

Syntax-highlighted preview of this file as included in the skill package.
Rendered Source
markdown200 linesFree
references/network-interconnect/api.md
1# CNI API Reference
2 
3See [README.md](README.md) for overview.
4 
5## Base
6 
7```
8https://api.cloudflare.com/client/v4
9Auth: Authorization: Bearer <token>
10```
11 
12## SDK Namespaces
13 
14**Primary (recommended):**
15```typescript
16client.networkInterconnects.interconnects.*
17client.networkInterconnects.cnis.*
18client.networkInterconnects.slots.*
19```
20 
21**Alternate (deprecated):**
22```typescript
23client.magicTransit.cfInterconnects.*
24```
25 
26Use `networkInterconnects` namespace for all new code.
27 
28## Interconnects
29 
30```http
31GET    /accounts/{account_id}/cni/interconnects              # Query: page, per_page
32POST   /accounts/{account_id}/cni/interconnects              # Query: validate_only=true (optional)
33GET    /accounts/{account_id}/cni/interconnects/{icon}
34GET    /accounts/{account_id}/cni/interconnects/{icon}/status
35GET    /accounts/{account_id}/cni/interconnects/{icon}/loa   # Returns PDF
36DELETE /accounts/{account_id}/cni/interconnects/{icon}
37```
38 
39**Create Body:** `account`, `slot_id`, `type`, `facility`, `speed`, `name`, `description`  
40**Status Values:** `active` | `healthy` | `unhealthy` | `pending` | `down`
41 
42**Response Example:**
43```json
44{"result": [{"id": "icon_abc", "name": "prod", "type": "direct", "facility": "EWR1", "speed": "10G", "status": "active"}]}
45```
46 
47## CNI Objects (BGP config)
48 
49```http
50GET    /accounts/{account_id}/cni/cnis
51POST   /accounts/{account_id}/cni/cnis
52GET    /accounts/{account_id}/cni/cnis/{cni}
53PUT    /accounts/{account_id}/cni/cnis/{cni}
54DELETE /accounts/{account_id}/cni/cnis/{cni}
55```
56 
57Body: `account`, `cust_ip`, `cf_ip`, `bgp_asn`, `bgp_password`, `vlan`
58 
59## Slots
60 
61```http
62GET /accounts/{account_id}/cni/slots
63GET /accounts/{account_id}/cni/slots/{slot}
64```
65 
66Query: `facility`, `occupied`, `speed`
67 
68## Health Checks
69 
70Configure via Magic Transit/WAN tunnel endpoints (CNI v2).
71 
72```typescript
73await client.magicTransit.tunnels.update(accountId, tunnelId, {
74  health_check: { enabled: true, target: '192.0.2.1', rate: 'high', type: 'request' },
75});
76```
77 
78Rates: `high` | `medium` | `low`. Types: `request` | `reply`. See [Magic Transit docs](https://developers.cloudflare.com/magic-transit/how-to/configure-tunnel-endpoints/#add-tunnels).
79 
80## Settings
81 
82```http
83GET /accounts/{account_id}/cni/settings
84PUT /accounts/{account_id}/cni/settings
85```
86 
87Body: `default_asn`
88 
89## TypeScript SDK
90 
91```typescript
92import Cloudflare from 'cloudflare';
93 
94const client = new Cloudflare({ apiToken: process.env.CF_TOKEN });
95 
96// List
97await client.networkInterconnects.interconnects.list({ account_id: id });
98 
99// Create with validation
100await client.networkInterconnects.interconnects.create({
101  account_id: id,
102  account: id,
103  slot_id: 'slot_abc',
104  type: 'direct',
105  facility: 'EWR1',
106  speed: '10G',
107  name: 'prod-interconnect',
108}, {
109  query: { validate_only: true }, // Dry-run validation
110});
111 
112// Create without validation
113await client.networkInterconnects.interconnects.create({
114  account_id: id,
115  account: id,
116  slot_id: 'slot_abc',
117  type: 'direct',
118  facility: 'EWR1',
119  speed: '10G',
120  name: 'prod-interconnect',
121});
122 
123// Status
124await client.networkInterconnects.interconnects.get(accountId, iconId);
125 
126// LOA (use fetch)
127const res = await fetch(`https://api.cloudflare.com/client/v4/accounts/${id}/cni/interconnects/${iconId}/loa`, {
128  headers: { Authorization: `Bearer ${token}` },
129});
130await fs.writeFile('loa.pdf', Buffer.from(await res.arrayBuffer()));
131 
132// CNI object
133await client.networkInterconnects.cnis.create({
134  account_id: id,
135  account: id,
136  cust_ip: '192.0.2.1/31',
137  cf_ip: '192.0.2.0/31',
138  bgp_asn: 65000,
139  vlan: 100,
140});
141 
142// Slots (filter by facility and speed)
143await client.networkInterconnects.slots.list({
144  account_id: id,
145  occupied: false,
146  facility: 'EWR1',
147  speed: '10G',
148});
149```
150 
151## Python SDK
152 
153```python
154from cloudflare import Cloudflare
155 
156client = Cloudflare(api_token=os.environ["CF_TOKEN"])
157 
158# List, create, status (same pattern as TypeScript)
159client.network_interconnects.interconnects.list(account_id=id)
160client.network_interconnects.interconnects.create(account_id=id, account=id, slot_id="slot_abc", type="direct", facility="EWR1", speed="10G")
161client.network_interconnects.interconnects.get(account_id=id, icon=icon_id)
162 
163# CNI objects and slots
164client.network_interconnects.cnis.create(account_id=id, cust_ip="192.0.2.1/31", cf_ip="192.0.2.0/31", bgp_asn=65000)
165client.network_interconnects.slots.list(account_id=id, occupied=False)
166```
167 
168## cURL
169 
170```bash
171# List interconnects
172curl "https://api.cloudflare.com/client/v4/accounts/${ACCOUNT_ID}/cni/interconnects" \
173  -H "Authorization: Bearer ${CF_TOKEN}"
174 
175# Create interconnect
176curl -X POST "https://api.cloudflare.com/client/v4/accounts/${ACCOUNT_ID}/cni/interconnects?validate_only=true" \
177  -H "Authorization: Bearer ${CF_TOKEN}" -H "Content-Type: application/json" \
178  -d '{"account": "id", "slot_id": "slot_abc", "type": "direct", "facility": "EWR1", "speed": "10G"}'
179 
180# LOA PDF
181curl "https://api.cloudflare.com/client/v4/accounts/${ACCOUNT_ID}/cni/interconnects/${ICON_ID}/loa" \
182  -H "Authorization: Bearer ${CF_TOKEN}" --output loa.pdf
183```
184 
185## Not Available via API
186 
187**Missing Capabilities:**
188- BGP session state query (use Dashboard or BGP logs)
189- Bandwidth utilization metrics (use external monitoring)
190- Traffic statistics per interconnect
191- Historical uptime/downtime data
192- Light level readings (contact account team)
193- Maintenance window scheduling (notifications only)
194 
195## Resources
196 
197- [API Docs](https://developers.cloudflare.com/api/resources/network_interconnects/)
198- [TypeScript SDK](https://github.com/cloudflare/cloudflare-typescript)
199- [Python SDK](https://github.com/cloudflare/cloudflare-python)
200
Preparing the source view

Cloudflare Platform Skill

references/network-interconnect/api.md
