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.
/api/v1/change-set-items/{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/change-set-items/string"/api/v1/change-sets/{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/change-sets/string"/api/v1/change-sets/{id}/applyAn 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/change-sets/string/apply" \ -H "Content-Type: application/json" \ -d '{}'{ "$schema": "https://example.com/ApplyBody.json", "approval": { "decidedAt": "2019-08-24T14:15:22Z", "decision": "string", "expiresAt": "2019-08-24T14:15:22Z", "id": "string", "kind": "string" }, "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "deployments": [ { "approvalId": "string", "id": "string", "releaseId": "string", "serviceId": "string", "state": "string" } ], "firstDeploys": [ { "buildId": "string", "deploymentId": "string", "serviceId": "string" } ], "unreleasedServiceIds": [ "string" ]}/api/v1/environments/{id}/change-setAn 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/environments/string/change-set"{ "$schema": "https://example.com/ViewBody.json", "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "environmentId": "string", "items": [ { "createdAt": "2019-08-24T14:15:22Z", "from": "string", "id": "string", "key": "string", "kind": "string", "label": "string", "managed": true, "processId": "string", "secret": true, "serviceId": "string", "serviceSlug": "string", "to": "string", "toEmpty": true, "volumeId": "string" } ], "projectConfig": { "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "items": [ { "createdAt": "2019-08-24T14:15:22Z", "from": "string", "id": "string", "key": "string", "kind": "string", "label": "string", "managed": true, "processId": "string", "secret": true, "serviceId": "string", "serviceSlug": "string", "to": "string", "toEmpty": true, "volumeId": "string" } ], "summary": { "affectedServiceIds": [ "string" ], "needsApproval": true, "requiresDowntime": true } }, "summary": { "affectedServiceIds": [ "string" ], "needsApproval": true, "requiresDowntime": true }}/api/v1/environments/{id}/change-set/itemsAn 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
Environment id.
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/environments/string/change-set/items" \ -H "Content-Type: application/json" \ -d '{ "kind": "variable.set" }'{ "$schema": "https://example.com/ViewBody.json", "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "environmentId": "string", "items": [ { "createdAt": "2019-08-24T14:15:22Z", "from": "string", "id": "string", "key": "string", "kind": "string", "label": "string", "managed": true, "processId": "string", "secret": true, "serviceId": "string", "serviceSlug": "string", "to": "string", "toEmpty": true, "volumeId": "string" } ], "projectConfig": { "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "items": [ { "createdAt": "2019-08-24T14:15:22Z", "from": "string", "id": "string", "key": "string", "kind": "string", "label": "string", "managed": true, "processId": "string", "secret": true, "serviceId": "string", "serviceSlug": "string", "to": "string", "toEmpty": true, "volumeId": "string" } ], "summary": { "affectedServiceIds": [ "string" ], "needsApproval": true, "requiresDowntime": true } }, "summary": { "affectedServiceIds": [ "string" ], "needsApproval": true, "requiresDowntime": true }}/api/v1/environments/{id}/change-set/items:batchAn 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
Environment id.
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/environments/string/change-set/items:batch" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "kind": "variable.set" } ] }'{ "$schema": "https://example.com/ViewBody.json", "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "environmentId": "string", "items": [ { "createdAt": "2019-08-24T14:15:22Z", "from": "string", "id": "string", "key": "string", "kind": "string", "label": "string", "managed": true, "processId": "string", "secret": true, "serviceId": "string", "serviceSlug": "string", "to": "string", "toEmpty": true, "volumeId": "string" } ], "projectConfig": { "changeSet": { "appliedAt": "2019-08-24T14:15:22Z", "approvalId": "string", "createdAt": "2019-08-24T14:15:22Z", "downtimeAccepted": true, "environmentId": "string", "id": "string", "message": "string", "reason": "string", "source": "console", "sourceCommit": "string", "state": "draft" }, "items": [ { "createdAt": "2019-08-24T14:15:22Z", "from": "string", "id": "string", "key": "string", "kind": "string", "label": "string", "managed": true, "processId": "string", "secret": true, "serviceId": "string", "serviceSlug": "string", "to": "string", "toEmpty": true, "volumeId": "string" } ], "summary": { "affectedServiceIds": [ "string" ], "needsApproval": true, "requiresDowntime": true } }, "summary": { "affectedServiceIds": [ "string" ], "needsApproval": true, "requiresDowntime": true }}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.
Build
Builds from Git: list, read logs, retry and cancel, and preview what a repository would build. Each operation lists its method and path, parameters, request body, responses and an example call.