Recently deleted
Deleted services, databases, volumes, environments and projects that can still be restored, and how long they stay. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/deletedAn 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/deleted"{ "$schema": "https://example.com/PageDeletedBody.json", "items": [ { "context": "string", "deletedAt": "2019-08-24T14:15:22Z", "deletedBy": { "id": "string", "name": "string", "type": "user" }, "detail": "string", "id": "string", "kind": "service", "name": "string", "projectId": "string", "restorable": true, "restoreUntil": "2019-08-24T14:15:22Z", "slug": "string" } ], "nextCursor": "string"}/api/v1/deleted/{kind}/{id}/purgeAn 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
What was deleted.
Value in
- "service"
- "database"
- "volume"
- "environment"
- "project"
The id the resource had when it was deleted.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/problem+json
curl -X POST "https://example.com/api/v1/deleted/service/string/purge" \ -H "Content-Type: application/json" \ -d '{ "confirm": "string" }'/api/v1/deleted/{kind}/{id}/restoreAn 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
What was deleted.
Value in
- "service"
- "database"
- "volume"
- "environment"
- "project"
The id the resource had when it was deleted.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/deleted/service/string/restore"{ "$schema": "https://example.com/RestoredBody.json", "id": "string", "kind": "string", "name": "string", "projectId": "string", "slug": "string", "stopped": true}/api/v1/organizations/{id}/deleted-retentionAn 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/organizations/string/deleted-retention"{ "$schema": "https://example.com/RetentionBody.json", "hours": 0}/api/v1/organizations/{id}/deleted-retentionAn 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 PUT "https://example.com/api/v1/organizations/string/deleted-retention" \ -H "Content-Type: application/json" \ -d '{ "hours": 0 }'{ "$schema": "https://example.com/RetentionBody.json", "hours": 0}Services
Services, their processes, pods and volumes, and how a service is suspended, resumed and restarted. Each operation lists its method and path, parameters, request body, responses and an example call.
Variables
Variables at every tier, external resources and the references between them. Each operation lists its method and path, parameters, request body, responses and an example call.