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.
/api/v1/notification-channelsAn 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/notification-channels"{ "$schema": "https://example.com/ListChannelsOutputBody.json", "items": [ { "$schema": "https://example.com/ChannelOutput.json", "createdAt": "2019-08-24T14:15:22Z", "enabled": true, "events": [ "string" ], "hint": "string", "id": "string", "kind": "slack", "label": "string", "lastDeliveredAt": "2019-08-24T14:15:22Z", "lastError": "string" } ]}/api/v1/notification-channelsAn 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 POST "https://example.com/api/v1/notification-channels" \ -H "Content-Type: application/json" \ -d '{ "events": [ "string" ], "kind": "slack", "label": "string", "secret": "string" }'{ "$schema": "https://example.com/ChannelOutput.json", "createdAt": "2019-08-24T14:15:22Z", "enabled": true, "events": [ "string" ], "hint": "string", "id": "string", "kind": "slack", "label": "string", "lastDeliveredAt": "2019-08-24T14:15:22Z", "lastError": "string"}/api/v1/notification-channels/{id}An 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
Path Parameters
Channel id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X PATCH "https://example.com/api/v1/notification-channels/string" \ -H "Content-Type: application/json" \ -d '{}'{ "$schema": "https://example.com/ChannelOutput.json", "createdAt": "2019-08-24T14:15:22Z", "enabled": true, "events": [ "string" ], "hint": "string", "id": "string", "kind": "slack", "label": "string", "lastDeliveredAt": "2019-08-24T14:15:22Z", "lastError": "string"}/api/v1/notification-channels/{id}An 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
Path Parameters
Channel id.
Response Body
application/problem+json
curl -X DELETE "https://example.com/api/v1/notification-channels/string"/api/v1/notification-channels/{id}/testAn 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
Path Parameters
Channel id.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/notification-channels/string/test"{ "$schema": "https://example.com/TestChannelOutputBody.json", "channel": { "$schema": "https://example.com/ChannelOutput.json", "createdAt": "2019-08-24T14:15:22Z", "enabled": true, "events": [ "string" ], "hint": "string", "id": "string", "kind": "slack", "label": "string", "lastDeliveredAt": "2019-08-24T14:15:22Z", "lastError": "string" }, "delivered": true}/api/v1/notificationsAn 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
Query Parameters
Opaque cursor from a previous response's nextCursor. Omit for the first page.
How many items to return.
int641 <= value <= 20050Only notifications not yet read.
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/notifications"{ "$schema": "https://example.com/ListNotificationsOutputBody.json", "items": [ { "body": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "string", "kind": "approval", "link": { "approvalId": "string", "clusterId": "string", "deploymentId": "string", "environmentId": "string", "projectId": "string", "serviceId": "string", "tab": "string", "type": "approval" }, "readAt": "2019-08-24T14:15:22Z", "title": "string" } ], "nextCursor": "string", "unreadCount": 0}/api/v1/notifications/readAn 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 POST "https://example.com/api/v1/notifications/read" \ -H "Content-Type: application/json" \ -d '{}'{ "$schema": "https://example.com/MarkReadOutputBody.json", "unreadCount": 0, "updated": 0}Object Stores
S3-compatible object stores that hold backups and archives. Each operation lists its method and path, parameters, request body, responses and an example call.
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.