Cloudflare
The organization's Cloudflare connection and the zones it can reach. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/cloudflare-connectionAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/cloudflare-connection"{ "$schema": "https://example.com/ConnectionBody.json", "accountId": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "string", "lastError": "string", "updatedAt": "2019-08-24T14:15:22Z", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/cloudflare-connectionAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Response Body
application/problem+json
curl -X DELETE "https://example.com/api/v1/cloudflare-connection"/api/v1/cloudflare-connectionAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X PUT "https://example.com/api/v1/cloudflare-connection" \ -H "Content-Type: application/json" \ -d '{}'{ "$schema": "https://example.com/ConnectionBody.json", "accountId": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "string", "lastError": "string", "updatedAt": "2019-08-24T14:15:22Z", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/cloudflare-connection/verifyAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/cloudflare-connection/verify"{ "$schema": "https://example.com/ConnectionBody.json", "accountId": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "string", "lastError": "string", "updatedAt": "2019-08-24T14:15:22Z", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/cloudflare-connection/zonesAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/cloudflare-connection/zones"{ "$schema": "https://example.com/ZonesOutputBody.json", "items": [ { "id": "string", "name": "string" } ]}Notifications
Your notification inbox, and the Slack and PagerDuty channels of the organization. Each operation lists its method and path, parameters, request body, responses and an example call.
Updates
The installed version, newer releases, and updating the control plane. Each operation lists its method and path, parameters, request body, responses and an example call.