deploy a build to an install

POST

installs

{install_id}

deploys

Authorizations

Authorization

string

headerrequired

Type "Bearer" followed by a space and token.

Path Parameters

install_id

string

required

install ID

Body

application/json

build_id

string

Response

201 - application/json

build_id

string

component_config_version

integer

component_id

string

component_name

string

created_at

string

created_by_id

string

install_component_id

string

install_deploy_type

enum<string>

Available options:

release,

install,

teardown,

plan-only

install_id

string

Fields that are de-nested at read time using AfterQuery

log_stream

object

release_id

string

runner_job

object

runner details

runner_job.available_timeout

integer

available timeout is how long a job can be marked as "available" before being requeued

runner_job.created_at

string

runner_job.created_by_id

string

runner_job.execution_count

integer

runner_job.execution_timeout

integer

execution timeout is how long a job can be marked as "exeucuting" before being requeued

runner_job.executions

object[]

runner_job.group

enum<string>

Available options:

health-checks,

sync,

build,

deploy,

sandbox,

runner,

operations,

user,

any

runner_job.id

string

runner_job.log_stream_id

string

runner_job.max_executions

integer

runner_job.operation

enum<string>

Available options:

exec,

apply,

destroy,

plan-only,

build,

unknown

runner_job.org_id

string

runner_job.overall_timeout

integer

overall timeout is how long a job can be attempted, before being cancelled

runner_job.owner_id

string

runner_job.owner_type

string

runner_job.queue_timeout

integer

queue timeout is how long a job can be queued, before being made available

runner_job.runner_id

string

runner_job.status

enum<string>

Available options:

queued,

available,

in-progress,

finished,

failed,

timed-out,

not-attempted,

cancelled,

unknown

runner_job.status_description

string

runner_job.type

enum<string>

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

runner_job.updated_at

string

status

string

status_description

string

updated_at

string

get the latest deploy for an install component get an install deploy

apps

components

installers

installs

releases

general

orgs

sandboxes

vcs

Authorizations

Path Parameters

Body

Response