apps
components
- GETget all components for an app
- GETget all components for an org
- GETget a component
- PATCHupdate a component
- GETGet all builds for a component
- POSTcreate component build
- GETget latest build for a component
- GETget a build for a component
- GETGet component build plan
- GETget all configs for a component
- POSTcreate a docker build component config
- POSTcreate an external image component config
- POSTcreate a helm component config
- POSTcreate a job component config
- GETget latest config for a component
- POSTcreate a terraform component config
installers
installs
- GETget all installs for an app
- POSTcreate an app install
- GETget an install
- POSTCreate an app install from an installer
- GETget all installs for an org
- DELdelete an install
- PATCHupdate an install
- GETget an install component
- GETget an installs components
- GETget an install components deploys
- GETget the latest deploy for an install component
- POSTdeploy a build to an install
- GETget an install deploy
- GETGet install deploy logs
- GETget install deploy plan
- GETget an installs inputs
- POSTcreate install inputs
- GETget an installs current inputs
- GETget an installs sandbox runs
releases
general
orgs
create an app install
Type "Bearer" followed by a space and token.
app ID
Authorizations
Type "Bearer" followed by a space and token.
Path Parameters
app ID
Body
Response
aws-ecs, aws-eks, azure-aks, azure-acs, local aws, azure, unknown cloud specific fields
fields set via after query
parent component
actual configuration
aws-ecs, aws-eks, azure-aks, azure-acs, local aws, azure, unknown Links are dynamically loaded using an after query
cloud specific fields
fields set via after query
parent component
actual configuration
TODO(jm): deprecate these fields once the terraform provider has been updated
terraform_module, helm_chart, docker_build, external_image, job, unknown release, install, teardown, plan-only Fields that are de-nested at read time using AfterQuery
runner details
after query fields filled in after querying
started, finished, noop, failed Links are dynamically loaded using an after query
cloud specific fields
fields set via after query
provision, reprovision, deprovision runner details
available timeout is how long a job can be marked as "available" before being requeued
execution timeout is how long a job can be marked as "exeucuting" before being requeued
health-checks, sync, build, deploy, sandbox, runner, operations, user, any exec, apply, destroy, plan-only, build, unknown overall timeout is how long a job can be attempted, before being cancelled
queue timeout is how long a job can be queued, before being made available
queued, available, in-progress, finished, failed, timed-out, not-attempted, cancelled, unknown health-check, docker-build, container-image-build, terraform-module-build, helm-chart-build, noop-build, oci-sync, noop-sync, terraform-deploy, helm-chart-deploy, job-deploy, noop-deploy, shut-down, noop, sandbox-terraform, runner-helm, runner-terraform, runner-local TODO(jm): deprecate these fields once the terraform provider has been updated
terraform_module, helm_chart, docker_build, external_image, job, unknown release, install, teardown, plan-only Fields that are de-nested at read time using AfterQuery
runner details
available timeout is how long a job can be marked as "available" before being requeued
execution timeout is how long a job can be marked as "exeucuting" before being requeued
pending, initializing, in-progress, cleaning-up, finished, failed, timed-out, not-attempted, cancelled, unknown health-checks, sync, build, deploy, sandbox, runner, operations, user, any exec, apply, destroy, plan-only, build, unknown overall timeout is how long a job can be attempted, before being cancelled
queue timeout is how long a job can be queued, before being made available
queued, available, in-progress, finished, failed, timed-out, not-attempted, cancelled, unknown health-check, docker-build, container-image-build, terraform-module-build, helm-chart-build, noop-build, oci-sync, noop-sync, terraform-deploy, helm-chart-deploy, job-deploy, noop-deploy, shut-down, noop, sandbox-terraform, runner-helm, runner-terraform, runner-local after query fields filled in after querying
started, finished, noop, failed Links are dynamically loaded using an after query
cloud specific fields
fields set via after query
parent component
actual configuration
provision, reprovision, deprovision runner details
available timeout is how long a job can be marked as "available" before being requeued
execution timeout is how long a job can be marked as "exeucuting" before being requeued
TODO(jm): add richer information on the error or other tied to a job execution.
pending, initializing, in-progress, cleaning-up, finished, failed, timed-out, not-attempted, cancelled, unknown health-checks, sync, build, deploy, sandbox, runner, operations, user, any exec, apply, destroy, plan-only, build, unknown overall timeout is how long a job can be attempted, before being cancelled
queue timeout is how long a job can be queued, before being made available
queued, available, in-progress, finished, failed, timed-out, not-attempted, cancelled, unknown health-check, docker-build, container-image-build, terraform-module-build, helm-chart-build, noop-build, oci-sync, noop-sync, terraform-deploy, helm-chart-deploy, job-deploy, noop-deploy, shut-down, noop, sandbox-terraform, runner-helm, runner-terraform, runner-local TODO(jm): deprecate these fields once the terraform provider has been updated