installs
get an install deploy
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
installs
get an install deploy
GET
/
v1
/
installs
/
{install_id}
/
deploys
/
latest
Authorization
string
*
Authorization
Required
string
Type "Bearer" followed by a space and token.
install_id
string
*
install_id
Required
string
install ID
Authorizations
Type "Bearer" followed by a space and token.
Path Parameters
install ID
Response
200 - application/json
Available options:
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
TODO(jm): add richer information on the error or other tied to a job execution.
Available options:
pending
, initializing
, in-progress
, cleaning-up
, finished
, failed
, timed-out
, not-attempted
, cancelled
, unknown
Available options:
health-checks
, sync
, build
, deploy
, sandbox
, runner
, operations
, user
,
, any
Available options:
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
Available options:
queued
, available
, in-progress
, finished
, failed
, timed-out
, not-attempted
, cancelled
, unknown
Available options:
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