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.
/api/v1/buildsAn 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 <= 20050Build status to filter by.
Value in
- "queued"
- "running"
- "succeeded"
- "failed"
- "superseded"
- "cancelled"
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/builds?status=queued"{ "$schema": "https://example.com/PageBuildDTO.json", "items": [ { "$schema": "https://example.com/BuildDTO.json", "actorUserId": "string", "branch": "string", "builder": { "detection": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }, "engine": "dockerfile" }, "cache": { "cachedSteps": 0, "totalSteps": 0 }, "clusterId": "string", "commitMessage": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "error": "string", "finishedAt": "2019-08-24T14:15:22Z", "id": "string", "imageRef": "string", "kind": "string", "number": 0, "releaseError": "string", "releaseErrorAt": "2019-08-24T14:15:22Z", "repository": "string", "repositoryConfig": { "commit": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "source": "string", "status": "absent", "summary": "string" }, "serviceId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string", "steps": [ { "finishedAt": "2019-08-24T14:15:22Z", "name": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string" } ], "trigger": "string" } ], "nextCursor": "string"}/api/v1/builds/{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/builds/string"{ "$schema": "https://example.com/BuildDTO.json", "actorUserId": "string", "branch": "string", "builder": { "detection": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }, "engine": "dockerfile" }, "cache": { "cachedSteps": 0, "totalSteps": 0 }, "clusterId": "string", "commitMessage": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "error": "string", "finishedAt": "2019-08-24T14:15:22Z", "id": "string", "imageRef": "string", "kind": "string", "number": 0, "releaseError": "string", "releaseErrorAt": "2019-08-24T14:15:22Z", "repository": "string", "repositoryConfig": { "commit": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "source": "string", "status": "absent", "summary": "string" }, "serviceId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string", "steps": [ { "finishedAt": "2019-08-24T14:15:22Z", "name": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string" } ], "trigger": "string"}/api/v1/builds/{id}/cancelAn 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/builds/string/cancel"{ "$schema": "https://example.com/BuildDTO.json", "actorUserId": "string", "branch": "string", "builder": { "detection": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }, "engine": "dockerfile" }, "cache": { "cachedSteps": 0, "totalSteps": 0 }, "clusterId": "string", "commitMessage": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "error": "string", "finishedAt": "2019-08-24T14:15:22Z", "id": "string", "imageRef": "string", "kind": "string", "number": 0, "releaseError": "string", "releaseErrorAt": "2019-08-24T14:15:22Z", "repository": "string", "repositoryConfig": { "commit": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "source": "string", "status": "absent", "summary": "string" }, "serviceId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string", "steps": [ { "finishedAt": "2019-08-24T14:15:22Z", "name": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string" } ], "trigger": "string"}/api/v1/builds/{id}/logsAn 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 lines to return.
int641 <= value <= 1000200Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/builds/string/logs"{ "$schema": "https://example.com/PageBuildLogLineDTO.json", "items": [ { "at": "2019-08-24T14:15:22Z", "seq": 0, "text": "string" } ], "nextCursor": "string"}/api/v1/builds/{id}/logs/streamAn 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
text/event-stream
application/problem+json
curl -X GET "https://example.com/api/v1/builds/string/logs/stream"[ { "data": { "at": "2019-08-24T14:15:22Z", "seq": 0, "text": "string" }, "event": "log", "id": 0, "retry": 0 }]/api/v1/builds/{id}/retryAn 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/builds/string/retry"{ "$schema": "https://example.com/BuildDTO.json", "actorUserId": "string", "branch": "string", "builder": { "detection": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }, "engine": "dockerfile" }, "cache": { "cachedSteps": 0, "totalSteps": 0 }, "clusterId": "string", "commitMessage": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "error": "string", "finishedAt": "2019-08-24T14:15:22Z", "id": "string", "imageRef": "string", "kind": "string", "number": 0, "releaseError": "string", "releaseErrorAt": "2019-08-24T14:15:22Z", "repository": "string", "repositoryConfig": { "commit": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "source": "string", "status": "absent", "summary": "string" }, "serviceId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string", "steps": [ { "finishedAt": "2019-08-24T14:15:22Z", "name": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string" } ], "trigger": "string"}/api/v1/env-template/parseAn 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/env-template/parse" \ -H "Content-Type: application/json" \ -d '{ "text": "string" }'{ "$schema": "https://example.com/ParseEnvTemplateOutputBody.json", "keys": [ { "comment": "string", "example": "string", "existing": true, "generateSuggested": true, "key": "string", "placeholder": true, "providedBy": "project", "required": true, "secretSuggested": true } ]}/api/v1/repository-config/detectAn 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/repository-config/detect" \ -H "Content-Type: application/json" \ -d '{ "branch": "string" }'{ "$schema": "https://example.com/DetectRepositoryConfigDto.json", "base": { "buildArgs": { "property1": "string", "property2": "string" }, "builder": "string", "dependsOn": [ "string" ], "dockerfile": "string", "env": { "property1": "string", "property2": "string" }, "hasProcesses": true, "mounts": [ { "destination": "string", "initialSize": 0, "processes": [ "string" ], "source": "string" } ], "processes": [ { "checks": { "liveness": "string", "readiness": "string", "startup": "string" }, "cmd": [ "string" ], "cpu": { "limit": 0, "request": 0 }, "drainSeconds": 0, "entrypoint": [ "string" ], "kind": "string", "memory": { "limit": 0, "request": 0 }, "metrics": { "enabled": true, "path": "string", "port": 0 }, "name": "string", "port": 0, "replicas": 0, "runAsUser": 0, "schedule": "string", "stabilizationSeconds": 0 } ], "releaseCommand": [ "string" ], "releaseCommandTimeoutSeconds": 0, "target": "string" }, "commit": "string", "databases": [ "string" ], "message": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "services": [ "string" ], "source": "string", "status": "absent", "summary": "string"}/api/v1/repository-config/detect-projectAn 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/repository-config/detect-project" \ -H "Content-Type: application/json" \ -d '{ "branch": "string" }'{ "$schema": "https://example.com/DetectProjectDto.json", "commit": "string", "envTemplate": { "$schema": "https://example.com/EnvTemplateDto.json", "keys": [ { "comment": "string", "example": "string", "existing": true, "generateSuggested": true, "key": "string", "placeholder": true, "providedBy": "project", "required": true, "secretSuggested": true } ], "message": "string", "reason": "unreadable-host", "source": { "commit": "string", "path": "string", "repository": "string" } }, "message": "string", "result": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }}/api/v1/services/{id}/buildsAn 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/services/string/builds"{ "$schema": "https://example.com/PageBuildDTO.json", "items": [ { "$schema": "https://example.com/BuildDTO.json", "actorUserId": "string", "branch": "string", "builder": { "detection": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }, "engine": "dockerfile" }, "cache": { "cachedSteps": 0, "totalSteps": 0 }, "clusterId": "string", "commitMessage": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "error": "string", "finishedAt": "2019-08-24T14:15:22Z", "id": "string", "imageRef": "string", "kind": "string", "number": 0, "releaseError": "string", "releaseErrorAt": "2019-08-24T14:15:22Z", "repository": "string", "repositoryConfig": { "commit": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "source": "string", "status": "absent", "summary": "string" }, "serviceId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string", "steps": [ { "finishedAt": "2019-08-24T14:15:22Z", "name": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string" } ], "trigger": "string" } ], "nextCursor": "string"}/api/v1/services/{id}/buildsAn 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/services/string/builds" \ -H "Content-Type: application/json" \ -d '{ "environmentId": "string" }'{ "$schema": "https://example.com/BuildDTO.json", "actorUserId": "string", "branch": "string", "builder": { "detection": { "buildCommand": "string", "buildable": true, "framework": "string", "installCommand": "string", "monorepo": true, "nodeVersion": "string", "outputDir": "string", "packageManager": "string", "packageManagerPinned": "string", "port": 0, "portSource": "script", "provider": "string", "signals": [ { "detail": "string", "path": "string" } ], "startCommand": "string", "static": true }, "engine": "dockerfile" }, "cache": { "cachedSteps": 0, "totalSteps": 0 }, "clusterId": "string", "commitMessage": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "error": "string", "finishedAt": "2019-08-24T14:15:22Z", "id": "string", "imageRef": "string", "kind": "string", "number": 0, "releaseError": "string", "releaseErrorAt": "2019-08-24T14:15:22Z", "repository": "string", "repositoryConfig": { "commit": "string", "path": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "source": "string", "status": "absent", "summary": "string" }, "serviceId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string", "steps": [ { "finishedAt": "2019-08-24T14:15:22Z", "name": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "string" } ], "trigger": "string"}/api/v1/services/{id}/env-templateAn 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
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/services/string/env-template?environmentId=string"{ "$schema": "https://example.com/EnvTemplateDto.json", "keys": [ { "comment": "string", "example": "string", "existing": true, "generateSuggested": true, "key": "string", "placeholder": true, "providedBy": "project", "required": true, "secretSuggested": true } ], "message": "string", "reason": "unreadable-host", "source": { "commit": "string", "path": "string", "repository": "string" }}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.
Databases
Database services: templates, connections, queries, readers and point-in-time recovery. Each operation lists its method and path, parameters, request body, responses and an example call.