Project config
The config repository of a project and the plans read from it. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/projects/{id}/configAn 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/projects/string/config"{ "$schema": "https://example.com/ConfigStateBody.json", "branches": [ { "branch": "string", "commitSha": "string", "message": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "readAt": "2019-08-24T14:15:22Z", "status": "ok" } ], "plans": [ { "approvalId": "string", "changeSetId": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "environmentSlug": "string", "id": "string", "message": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "state": "unchanged", "summary": { "created": [ "string" ], "items": { "property1": 0, "property2": 0 } } } ], "repository": { "gitConnectionId": "string", "gitUrl": "string", "kind": "git", "repository": "string", "webhook": "github-app" }}/api/v1/projects/{id}/configAn 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/projects/string/config"/api/v1/projects/{id}/configAn 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/config" \ -H "Content-Type: application/json" \ -d '{ "source": { "kind": "git" } }'{ "$schema": "https://example.com/ConfigStateBody.json", "branches": [ { "branch": "string", "commitSha": "string", "message": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "readAt": "2019-08-24T14:15:22Z", "status": "ok" } ], "plans": [ { "approvalId": "string", "changeSetId": "string", "commitSha": "string", "createdAt": "2019-08-24T14:15:22Z", "environmentId": "string", "environmentSlug": "string", "id": "string", "message": "string", "problems": [ { "line": 0, "message": "string", "path": "string" } ], "state": "unchanged", "summary": { "created": [ "string" ], "items": { "property1": 0, "property2": 0 } } } ], "repository": { "gitConnectionId": "string", "gitUrl": "string", "kind": "git", "repository": "string", "webhook": "github-app" }}/api/v1/projects/{id}/config/readAn 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/projects/string/config/read"{ "$schema": "https://example.com/ConfigReadBody.json", "branches": [ { "branch": "string", "commitSha": "string" } ]}Compose import
Preview and import the services of a repository's Compose files. Each operation lists its method and path, parameters, request body, responses and an example call.
Previews
Pull request preview environments of a project. Each operation lists its method and path, parameters, request body, responses and an example call.