create an app install

app_id

string

app_runner_config

object

app_sandbox_config

object

app_sandbox_config.app_id

string

app_sandbox_config.artifacts

object

Links are dynamically loaded using an after query

app_sandbox_config.aws_delegation_config

object

cloud specific fields

app_sandbox_config.aws_region_type

string

app_sandbox_config.cloud_platform

string

fields set via after query

app_sandbox_config.connected_github_vcs_config

object

app_sandbox_config.connected_github_vcs_config.branch

string

app_sandbox_config.connected_github_vcs_config.component_config_id

string

parent component

app_sandbox_config.connected_github_vcs_config.component_config_type

string

app_sandbox_config.connected_github_vcs_config.created_at

string

app_sandbox_config.connected_github_vcs_config.created_by_id

string

app_sandbox_config.connected_github_vcs_config.directory

string

app_sandbox_config.connected_github_vcs_config.id

string

app_sandbox_config.connected_github_vcs_config.repo

string

app_sandbox_config.connected_github_vcs_config.repo_name

string

app_sandbox_config.connected_github_vcs_config.repo_owner

string

app_sandbox_config.connected_github_vcs_config.updated_at

string

app_sandbox_config.connected_github_vcs_config.vcs_connection

object

app_sandbox_config.connected_github_vcs_config.vcs_connection_id

string

app_sandbox_config.created_at

string

app_sandbox_config.created_by_id

string

app_sandbox_config.id

string

app_sandbox_config.org_id

string

app_sandbox_config.public_git_vcs_config

object

app_sandbox_config.terraform_version

string

app_sandbox_config.updated_at

string

app_sandbox_config.variables

object

aws_account

object

azure_account

object

azure_account.created_at

string

azure_account.created_by_id

string

azure_account.id

string

azure_account.install

object

azure_account.install.app_id

string

azure_account.install.app_runner_config

object

azure_account.install.app_sandbox_config

object

azure_account.install.app_sandbox_config.app_id

string

azure_account.install.app_sandbox_config.artifacts

object

Links are dynamically loaded using an after query

azure_account.install.app_sandbox_config.aws_delegation_config

object

cloud specific fields

azure_account.install.app_sandbox_config.aws_region_type

string

azure_account.install.app_sandbox_config.cloud_platform

string

fields set via after query

azure_account.install.app_sandbox_config.connected_github_vcs_config

object

azure_account.install.app_sandbox_config.created_at

string

azure_account.install.app_sandbox_config.created_by_id

string

azure_account.install.app_sandbox_config.id

string

azure_account.install.app_sandbox_config.org_id

string

azure_account.install.app_sandbox_config.public_git_vcs_config

object

azure_account.install.app_sandbox_config.terraform_version

string

azure_account.install.app_sandbox_config.updated_at

string

azure_account.install.app_sandbox_config.variables

object

azure_account.install.aws_account

object

azure_account.install.azure_account

object

azure_account.install.azure_account.created_at

string

azure_account.install.azure_account.created_by_id

string

azure_account.install.azure_account.id

string

azure_account.install.azure_account.install

object

azure_account.install.azure_account.location

string

azure_account.install.azure_account.service_principal_app_id

string

azure_account.install.azure_account.service_principal_password

string

azure_account.install.azure_account.subscription_id

string

azure_account.install.azure_account.subscription_tenant_id

string

azure_account.install.azure_account.updated_at

string

azure_account.install.component_statuses

object

azure_account.install.composite_component_status

string

azure_account.install.created_at

string

azure_account.install.created_by_id

string

azure_account.install.id

string

azure_account.install.install_components

object[]

azure_account.install.install_components.component

object

azure_account.install.install_components.component_id

string

azure_account.install.install_components.created_at

string

azure_account.install.install_components.created_by_id

string

azure_account.install.install_components.id

string

azure_account.install.install_components.install_deploys

object[]

azure_account.install.install_components.install_id

string

azure_account.install.install_components.status

string

after query fields filled in after querying

azure_account.install.install_components.updated_at

string

azure_account.install.install_events

object[]

azure_account.install.install_inputs

object[]

azure_account.install.install_number

integer

azure_account.install.install_sandbox_runs

object[]

azure_account.install.install_sandbox_runs.app_sandbox_config

object

azure_account.install.install_sandbox_runs.created_at

string

azure_account.install.install_sandbox_runs.created_by_id

string

azure_account.install.install_sandbox_runs.id

string

azure_account.install.install_sandbox_runs.install_id

string

azure_account.install.install_sandbox_runs.log_stream

object

azure_account.install.install_sandbox_runs.run_type

enum<string>

Available options:

provision,

reprovision,

deprovision

azure_account.install.install_sandbox_runs.runner_job

object

runner details

azure_account.install.install_sandbox_runs.runner_job.available_timeout

integer

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

azure_account.install.install_sandbox_runs.runner_job.created_at

string

azure_account.install.install_sandbox_runs.runner_job.created_by_id

string

azure_account.install.install_sandbox_runs.runner_job.execution_count

integer

azure_account.install.install_sandbox_runs.runner_job.execution_time

integer

azure_account.install.install_sandbox_runs.runner_job.execution_timeout

integer

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

azure_account.install.install_sandbox_runs.runner_job.executions

object[]

azure_account.install.install_sandbox_runs.runner_job.final_runner_job_execution_id

string

azure_account.install.install_sandbox_runs.runner_job.finished_at

string

azure_account.install.install_sandbox_runs.runner_job.group

enum<string>

Available options:

health-checks,

sync,

build,

deploy,

sandbox,

runner,

operations,

actions,

,

any

azure_account.install.install_sandbox_runs.runner_job.id

string

azure_account.install.install_sandbox_runs.runner_job.log_stream_id

string

azure_account.install.install_sandbox_runs.runner_job.max_executions

integer

azure_account.install.install_sandbox_runs.runner_job.operation

enum<string>

Available options:

exec,

apply,

destroy,

plan-only,

build,

unknown

azure_account.install.install_sandbox_runs.runner_job.org_id

string

azure_account.install.install_sandbox_runs.runner_job.outputs

object

azure_account.install.install_sandbox_runs.runner_job.outputs_json

integer[]

azure_account.install.install_sandbox_runs.runner_job.overall_timeout

integer

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

azure_account.install.install_sandbox_runs.runner_job.owner_id

string

azure_account.install.install_sandbox_runs.runner_job.owner_type

string

azure_account.install.install_sandbox_runs.runner_job.queue_timeout

integer

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

azure_account.install.install_sandbox_runs.runner_job.runner_id

string

azure_account.install.install_sandbox_runs.runner_job.started_at

string

azure_account.install.install_sandbox_runs.runner_job.status

enum<string>

Available options:

queued,

available,

in-progress,

finished,

failed,

timed-out,

not-attempted,

cancelled,

unknown

azure_account.install.install_sandbox_runs.runner_job.status_description

string

azure_account.install.install_sandbox_runs.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,

actions-workflow

azure_account.install.install_sandbox_runs.runner_job.updated_at

string

azure_account.install.install_sandbox_runs.status

string

azure_account.install.install_sandbox_runs.status_description

string

azure_account.install.install_sandbox_runs.updated_at

string

azure_account.install.name

string

azure_account.install.runner_id

string

azure_account.install.runner_status

string

azure_account.install.sandbox_status

string

azure_account.install.status

string

TODO(jm): deprecate these fields once the terraform provider has been updated

azure_account.install.status_description

string

azure_account.install.updated_at

string

azure_account.location

string

azure_account.service_principal_app_id

string

azure_account.service_principal_password

string

azure_account.subscription_id

string

azure_account.subscription_tenant_id

string

azure_account.updated_at

string

component_statuses

object

composite_component_status

string

created_at

string

created_by_id

string

id

string

install_components

object[]

install_components.component

object

install_components.component_id

string

install_components.created_at

string

install_components.created_by_id

string

install_components.id

string

install_components.install_deploys

object[]

install_components.install_deploys.build_id

string

install_components.install_deploys.component_config_version

integer

install_components.install_deploys.component_id

string

install_components.install_deploys.component_name

string

install_components.install_deploys.created_at

string

install_components.install_deploys.created_by_id

string

install_components.install_deploys.id

string

install_components.install_deploys.install_component_id

string

install_components.install_deploys.install_deploy_type

enum<string>

Available options:

release,

install,

teardown,

plan-only

install_components.install_deploys.install_id

string

Fields that are de-nested at read time using AfterQuery

install_components.install_deploys.log_stream

object

install_components.install_deploys.release_id

string

install_components.install_deploys.runner_jobs

object[]

runner details

install_components.install_deploys.runner_jobs.available_timeout

integer

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

install_components.install_deploys.runner_jobs.created_at

string

install_components.install_deploys.runner_jobs.created_by_id

string

install_components.install_deploys.runner_jobs.execution_count

integer

install_components.install_deploys.runner_jobs.execution_time

integer

install_components.install_deploys.runner_jobs.execution_timeout

integer

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

install_components.install_deploys.runner_jobs.executions

object[]

install_components.install_deploys.runner_jobs.final_runner_job_execution_id

string

install_components.install_deploys.runner_jobs.finished_at

string

install_components.install_deploys.runner_jobs.group

enum<string>

Available options:

health-checks,

sync,

build,

deploy,

sandbox,

runner,

operations,

actions,

,

any

install_components.install_deploys.runner_jobs.id

string

install_components.install_deploys.runner_jobs.log_stream_id

string

install_components.install_deploys.runner_jobs.max_executions

integer

install_components.install_deploys.runner_jobs.operation

enum<string>

Available options:

exec,

apply,

destroy,

plan-only,

build,

unknown

install_components.install_deploys.runner_jobs.org_id

string

install_components.install_deploys.runner_jobs.outputs

object

install_components.install_deploys.runner_jobs.outputs_json

integer[]

install_components.install_deploys.runner_jobs.overall_timeout

integer

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

install_components.install_deploys.runner_jobs.owner_id

string

install_components.install_deploys.runner_jobs.owner_type

string

install_components.install_deploys.runner_jobs.queue_timeout

integer

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

install_components.install_deploys.runner_jobs.runner_id

string

install_components.install_deploys.runner_jobs.started_at

string

install_components.install_deploys.runner_jobs.status

enum<string>

Available options:

queued,

available,

in-progress,

finished,

failed,

timed-out,

not-attempted,

cancelled,

unknown

install_components.install_deploys.runner_jobs.status_description

string

install_components.install_deploys.runner_jobs.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,

actions-workflow

install_components.install_deploys.runner_jobs.updated_at

string

install_components.install_deploys.status

string

install_components.install_deploys.status_description

string

install_components.install_deploys.updated_at

string

install_components.install_id

string

install_components.status

string

after query fields filled in after querying

install_components.updated_at

string

install_events

object[]

install_inputs

object[]

install_number

integer

install_sandbox_runs

object[]

install_sandbox_runs.app_sandbox_config

object

install_sandbox_runs.app_sandbox_config.app_id

string

install_sandbox_runs.app_sandbox_config.artifacts

object

Links are dynamically loaded using an after query

install_sandbox_runs.app_sandbox_config.aws_delegation_config

object

cloud specific fields

install_sandbox_runs.app_sandbox_config.aws_region_type

string

install_sandbox_runs.app_sandbox_config.cloud_platform

string

fields set via after query

install_sandbox_runs.app_sandbox_config.connected_github_vcs_config

object

install_sandbox_runs.app_sandbox_config.created_at

string

install_sandbox_runs.app_sandbox_config.created_by_id

string

install_sandbox_runs.app_sandbox_config.id

string

install_sandbox_runs.app_sandbox_config.org_id

string

install_sandbox_runs.app_sandbox_config.public_git_vcs_config

object

install_sandbox_runs.app_sandbox_config.terraform_version

string

install_sandbox_runs.app_sandbox_config.updated_at

string

install_sandbox_runs.app_sandbox_config.variables

object

install_sandbox_runs.created_at

string

install_sandbox_runs.created_by_id

string

install_sandbox_runs.id

string

install_sandbox_runs.install_id

string

install_sandbox_runs.log_stream

object

install_sandbox_runs.run_type

enum<string>

Available options:

provision,

reprovision,

deprovision

install_sandbox_runs.runner_job

object

runner details

install_sandbox_runs.runner_job.available_timeout

integer

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

install_sandbox_runs.runner_job.created_at

string

install_sandbox_runs.runner_job.created_by_id

string

install_sandbox_runs.runner_job.execution_count

integer

install_sandbox_runs.runner_job.execution_time

integer

install_sandbox_runs.runner_job.execution_timeout

integer

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

install_sandbox_runs.runner_job.executions

object[]

install_sandbox_runs.runner_job.final_runner_job_execution_id

string

install_sandbox_runs.runner_job.finished_at

string

install_sandbox_runs.runner_job.group

enum<string>

Available options:

health-checks,

sync,

build,

deploy,

sandbox,

runner,

operations,

actions,

,

any

install_sandbox_runs.runner_job.id

string

install_sandbox_runs.runner_job.log_stream_id

string

install_sandbox_runs.runner_job.max_executions

integer

install_sandbox_runs.runner_job.operation

enum<string>

Available options:

exec,

apply,

destroy,

plan-only,

build,

unknown

install_sandbox_runs.runner_job.org_id

string

install_sandbox_runs.runner_job.outputs

object

install_sandbox_runs.runner_job.outputs_json

integer[]

install_sandbox_runs.runner_job.overall_timeout

integer

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

install_sandbox_runs.runner_job.owner_id

string

install_sandbox_runs.runner_job.owner_type

string

install_sandbox_runs.runner_job.queue_timeout

integer

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

install_sandbox_runs.runner_job.runner_id

string

install_sandbox_runs.runner_job.started_at

string

install_sandbox_runs.runner_job.status

enum<string>

Available options:

queued,

available,

in-progress,

finished,

failed,

timed-out,

not-attempted,

cancelled,

unknown

install_sandbox_runs.runner_job.status_description

string

install_sandbox_runs.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,

actions-workflow

install_sandbox_runs.runner_job.updated_at

string

install_sandbox_runs.status

string

install_sandbox_runs.status_description

string

install_sandbox_runs.updated_at

string

name

string

runner_id

string

runner_status

string

sandbox_status

string

status

string

TODO(jm): deprecate these fields once the terraform provider has been updated

status_description

string

updated_at

string

Authorizations

Path Parameters

Body

Response