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
Get an org
Type "Bearer" followed by a space and token.
Authorizations
Type "Bearer" followed by a space and token.
Response
ok, error, in-progress, provisioning, deprovisioning Filled in at read time
ok, error, in-progress, provisioning, deprovisioning parent can org, install or in the future, builtin runner group
aws-ecs, aws-eks, azure-aks, azure-acs, local 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 job details
provision, reprovision, deprovision 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 specific configuration for cloud specific runners, such as AWS or Azure
configuration for deploying the runner
Various settings for the runner to handle internally
Metadata is used as both log and metric tags/attributes in the runner when emitting data
configuration for managing the runner server side
install, org