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.
/api/v1/environments/{id}/dependenciesAn 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/dependencies"{ "$schema": "https://example.com/DependenciesBody.json", "edges": [ { "fromServiceId": "string", "keys": [ "string" ], "toExternalResourceId": "string", "toServiceId": "string" } ], "sharedUsage": [ { "key": "string", "serviceIds": [ "string" ] } ]}/api/v1/environments/{id}/external-resourcesAn 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
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/environments/string/external-resources"{ "$schema": "https://example.com/PageExternalResourceBody.json", "items": [ { "$schema": "https://example.com/ExternalResourceBody.json", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "id": "string", "kind": "string", "name": "string", "serviceIds": [ "string" ], "variables": { "property1": "string", "property2": "string" } } ], "nextCursor": "string"}/api/v1/environments/{id}/external-resourcesAn 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/environments/string/external-resources" \ -H "Content-Type: application/json" \ -d '{ "kind": "postgres", "name": "string", "variables": { "property1": "string", "property2": "string" } }'{ "$schema": "https://example.com/ExternalResourceBody.json", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "id": "string", "kind": "string", "name": "string", "serviceIds": [ "string" ], "variables": { "property1": "string", "property2": "string" }}/api/v1/environments/{id}/reference-targetsAn 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.
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/environments/string/reference-targets"{ "$schema": "https://example.com/ReferenceTargetsBody.json", "functions": [ { "arg": { "default": 0, "max": 0, "min": 0, "name": "string" }, "description": "string", "name": "string", "signature": "string" } ], "targets": [ { "keys": [ { "key": "string", "secret": true, "tier": "service" } ], "kind": "postgres", "name": "string", "serviceId": "string", "slug": "string", "staged": true } ]}/api/v1/environments/{id}/variablesAn 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
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/environments/string/variables"{ "$schema": "https://example.com/PageVariableBody.json", "items": [ { "empty": true, "environmentId": "string", "id": "string", "key": "string", "managedBy": "repo-config", "managedCommit": "string", "managedPath": "string", "scope": "project", "secret": true, "serviceId": "string", "updatedAt": "2019-08-24T14:15:22Z", "value": "string" } ], "nextCursor": "string"}/api/v1/environments/{id}/variablesAn 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/environments/string/variables" \ -H "Content-Type: application/json" \ -d '[ { "key": "string", "secret": true, "value": "string" } ]'{ "$schema": "https://example.com/SetVariablesOutputBody.json", "items": [ { "empty": true, "environmentId": "string", "id": "string", "key": "string", "managedBy": "repo-config", "managedCommit": "string", "managedPath": "string", "scope": "project", "secret": true, "serviceId": "string", "updatedAt": "2019-08-24T14:15:22Z", "value": "string" } ]}/api/v1/external-resources/{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/external-resources/string" \ -H "Content-Type: application/json" \ -d '{}'{ "$schema": "https://example.com/ExternalResourceBody.json", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "id": "string", "kind": "string", "name": "string", "serviceIds": [ "string" ], "variables": { "property1": "string", "property2": "string" }}/api/v1/external-resources/{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/external-resources/string"/api/v1/external-resources/{id}/linksAn 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/external-resources/string/links" \ -H "Content-Type: application/json" \ -d '{ "serviceIds": [ "string" ] }'{ "$schema": "https://example.com/LinksOutputBody.json", "serviceIds": [ "string" ]}/api/v1/projects/{id}/variablesAn 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
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/projects/string/variables"{ "$schema": "https://example.com/PageVariableBody.json", "items": [ { "empty": true, "environmentId": "string", "id": "string", "key": "string", "managedBy": "repo-config", "managedCommit": "string", "managedPath": "string", "scope": "project", "secret": true, "serviceId": "string", "updatedAt": "2019-08-24T14:15:22Z", "value": "string" } ], "nextCursor": "string"}/api/v1/projects/{id}/variablesAn 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/projects/string/variables" \ -H "Content-Type: application/json" \ -d '[ { "key": "string", "secret": true, "value": "string" } ]'{ "$schema": "https://example.com/SetVariablesOutputBody.json", "items": [ { "empty": true, "environmentId": "string", "id": "string", "key": "string", "managedBy": "repo-config", "managedCommit": "string", "managedPath": "string", "scope": "project", "secret": true, "serviceId": "string", "updatedAt": "2019-08-24T14:15:22Z", "value": "string" } ]}/api/v1/variables/{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/variables/string"/api/v1/variables/{id}/revealAn 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/variables/string/reveal"{ "$schema": "https://example.com/RevealOutputBody.json", "value": "string"}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.
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.