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.
/api/v1/object-storesAn 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 <= 20050Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/object-stores"{ "$schema": "https://example.com/PageObjectStoreBody.json", "items": [ { "$schema": "https://example.com/ObjectStoreBody.json", "accessKeyId": "string", "bucket": "string", "createdAt": "2019-08-24T14:15:22Z", "endpoint": "string", "forcePathStyle": true, "id": "string", "lastError": "string", "name": "string", "organizationId": "string", "prefix": "string", "region": "string", "verifiedAt": "2019-08-24T14:15:22Z" } ], "nextCursor": "string"}/api/v1/object-storesAn 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/object-stores" \ -H "Content-Type: application/json" \ -d '{ "accessKeyId": "string", "bucket": "string", "endpoint": "string", "name": "string", "secretAccessKey": "string" }'{ "$schema": "https://example.com/ObjectStoreBody.json", "accessKeyId": "string", "bucket": "string", "createdAt": "2019-08-24T14:15:22Z", "endpoint": "string", "forcePathStyle": true, "id": "string", "lastError": "string", "name": "string", "organizationId": "string", "prefix": "string", "region": "string", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/object-stores/{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
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/object-stores/string"{ "$schema": "https://example.com/ObjectStoreBody.json", "accessKeyId": "string", "bucket": "string", "createdAt": "2019-08-24T14:15:22Z", "endpoint": "string", "forcePathStyle": true, "id": "string", "lastError": "string", "name": "string", "organizationId": "string", "prefix": "string", "region": "string", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/object-stores/{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
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/object-stores/string" \ -H "Content-Type: application/json" \ -d '{ "accessKeyId": "string", "bucket": "string", "endpoint": "string", "name": "string" }'{ "$schema": "https://example.com/ObjectStoreBody.json", "accessKeyId": "string", "bucket": "string", "createdAt": "2019-08-24T14:15:22Z", "endpoint": "string", "forcePathStyle": true, "id": "string", "lastError": "string", "name": "string", "organizationId": "string", "prefix": "string", "region": "string", "verifiedAt": "2019-08-24T14:15:22Z"}/api/v1/object-stores/{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
Response Body
application/problem+json
curl -X DELETE "https://example.com/api/v1/object-stores/string"/api/v1/object-stores/{id}/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
Path Parameters
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/object-stores/string/verify"{ "$schema": "https://example.com/ObjectStoreBody.json", "accessKeyId": "string", "bucket": "string", "createdAt": "2019-08-24T14:15:22Z", "endpoint": "string", "forcePathStyle": true, "id": "string", "lastError": "string", "name": "string", "organizationId": "string", "prefix": "string", "region": "string", "verifiedAt": "2019-08-24T14:15:22Z"}Volume Backups
Backups and restores of volumes, and their schedules. Each operation lists its method and path, parameters, request body, responses and an example call.
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.