Approvals
Approvals that hold a change to a protected environment until a person decides. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/approvalsAn 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 <= 20050"pending"Value in
- "pending"
- "decided"
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/approvals"{ "$schema": "https://example.com/PageApprovalDTO.json", "items": [ { "$schema": "https://example.com/ApprovalDTO.json", "changeSetId": "string", "createdAt": "2019-08-24T14:15:22Z", "decidedAt": "2019-08-24T14:15:22Z", "decidedBy": "string", "decision": "string", "diff": null, "environmentId": "string", "expiresAt": "2019-08-24T14:15:22Z", "id": "string", "impact": null, "kind": "deploy", "reason": "string", "requestedBy": "string", "target": null } ], "nextCursor": "string"}/api/v1/approvals/{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/approvals/string"{ "$schema": "https://example.com/ApprovalDetailDTO.json", "blastRadius": [ { "id": "string", "name": "string", "slug": "string" } ], "changeSetId": "string", "checks": [ { "detail": "string", "durationSeconds": 0, "id": "build", "status": "passed" } ], "commits": [ { "at": "2019-08-24T14:15:22Z", "author": "string", "message": "string", "sha": "string", "url": "string" } ], "createdAt": "2019-08-24T14:15:22Z", "decidedAt": "2019-08-24T14:15:22Z", "decidedBy": "string", "decision": "string", "diff": null, "environmentId": "string", "expiresAt": "2019-08-24T14:15:22Z", "id": "string", "impact": null, "kind": "deploy", "reason": "string", "requestedBy": "string", "target": null}/api/v1/approvals/{id}/decideAn 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 POST "https://example.com/api/v1/approvals/string/decide" \ -H "Content-Type: application/json" \ -d '{ "decision": "approved" }'{ "$schema": "https://example.com/ApprovalDTO.json", "changeSetId": "string", "createdAt": "2019-08-24T14:15:22Z", "decidedAt": "2019-08-24T14:15:22Z", "decidedBy": "string", "decision": "string", "diff": null, "environmentId": "string", "expiresAt": "2019-08-24T14:15:22Z", "id": "string", "impact": null, "kind": "deploy", "reason": "string", "requestedBy": "string", "target": null}Releases
Releases and deployments: deploy an image, watch a deployment, cancel it, roll back or promote. Each operation lists its method and path, parameters, request body, responses and an example call.
Change Sets
The staged changes of an environment: stage, review, apply or discard. Each operation lists its method and path, parameters, request body, responses and an example call.