Skip to content

get an install

GET
/v1/installs/{install_id}

Forget an install that has been deleted outside of nuon.

This should only be used in cases where an install was broken in an unordinary way and needs to be manually deleted so the parent resources can be deleted.

Authorizations

Parameters

Path Parameters

install_id
required
string

Install ID

Responses

200

OK

object
app_id
string
app_runner_config
object
app_id
string
app_runner_type
string
Allowed values: aws-ecs aws-eks azure-aks azure-acs local
cloud_platform
string
Allowed values: aws azure unknown
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
org_id
string
updated_at
string
app_sandbox_config
object
app_id
string
artifacts

Links are dynamically loaded using an after query

object
cloudformation_stack_template
string
deprovision_policy
string
provision_policy
string
trust_policy
string
aws_delegation_config

Cloud specific fields

object
app_sandbox_config_id
string
created_at
string
created_by_id
string
iam_role_arn
string
id
string
org_id
string
updated_at
string
aws_region_type
string
cloud_platform

Fields set via after query

string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
id
string
org_id
string
public_git_vcs_config
object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
terraform_version
string
updated_at
string
variables
object
key
additional properties
string
aws_account
object
created_at
string
created_by_id
string
iam_role_arn
string
id
string
region
string
updated_at
string
azure_account
object
created_at
string
created_by_id
string
id
string
install
object recursive
location
string
service_principal_app_id
string
service_principal_password
string
subscription_id
string
subscription_tenant_id
string
updated_at
string
component_statuses
object
key
additional properties
string
composite_component_status
string
composite_component_status_description
string
created_at
string
created_by_id
string
id
string
install_action_workflows
Array<object>
object
action_workflow
object
app_id
string
config_count
integer
configs
Array<object>
object
action_workflow_id
string
app_config_id
string
app_id
string
created_at
string
created_by_id
string
id
string
steps
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
command
string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
idx
integer
name

Metadata

string
previous_step_id
string
public_git_vcs_config

All the details needed for a step

object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
updated_at
string
timeout
integer
triggers
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
created_at
string
created_by_id
string
cron_schedule
string
id
string
type
string
updated_at
string
updated_at
string
created_at
string
created_by_id
string
id
string
name

Metadata

string
status

TODO: change to default null after migration & after initial pr

string
status_description
string
updated_at
string
action_workflow_id
string
created_at
string
created_by_id
string
id
string
install_id
string
runs
Array<object>
object
action_workflow_config_id
string
config
object
action_workflow_id
string
app_config_id
string
app_id
string
created_at
string
created_by_id
string
id
string
steps
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
command
string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
idx
integer
name

Metadata

string
previous_step_id
string
public_git_vcs_config

All the details needed for a step

object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
updated_at
string
timeout
integer
triggers
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
created_at
string
created_by_id
string
cron_schedule
string
id
string
type
string
updated_at
string
updated_at
string
created_at
string
created_by_id
string
execution_time
integer
id
string
install_action_workflow
object recursive
install_action_workflow_id
string
install_id
string
log_stream
object
attrs
object
key
additional properties
string
created_at
string
created_by_id
string
id
string
open
boolean
org_id
string
owner_id
string
owner_type
string
runner_api_url
string
updated_at
string
write_token
string
outputs
object
key
additional properties
any
run_env_vars
object
key
additional properties
string
runner_job
object
available_timeout

Available timeout is how long a job can be marked as “available” before being requeued

integer
created_at
string
created_by_id
string
execution_count
integer
execution_time
integer
execution_timeout

Execution timeout is how long a job can be marked as “exeucuting” before being requeued

integer
executions
Array<object>
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
key
additional properties
object
outputs_json
string
runner_job_execution_id
string
updated_at
string
result
object
created_at
string
created_by_id
string
error_code
integer
error_metadata
object
key
additional properties
string
id
string
org_id
string
runner_job_execution_id
string
success
boolean
updated_at
string
runner_job_id
string
status
string
Allowed values: pending initializing in-progress cleaning-up finished failed timed-out not-attempted cancelled unknown
updated_at
string
final_runner_job_execution_id
string
finished_at
string
group
string
Allowed values: health-checks sync build deploy sandbox runner operations actions "" any
id
string
log_stream_id
string
max_executions
integer
metadata
object
key
additional properties
string
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
string
outputs
object
key
additional properties
any
outputs_json
string
overall_timeout

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

integer
owner_id
string
owner_type
string
queue_timeout

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

integer
runner_id
string
started_at
string
status
string
Allowed values: queued available in-progress finished failed timed-out not-attempted cancelled unknown
status_description
string
type
string
Allowed values: 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 update-version noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow
updated_at
string
status
string
status_description
string
steps
Array<object>
object
created_at
string
created_by_id
string
execution_duration
integer
id
string
install_action_workflow_run_id
string
status
string
Allowed values: finished pending in-progress error
step_id
string
updated_at
string
trigger_type
string
Allowed values: manual cron pre-sandbox-run post-sandbox-run pre-deploy post-deploy
triggered_by_id
string
triggered_by_type
string
updated_at
string
status

After query fields filled in after querying

string
updated_at
string
install_components
Array<object>
object
component
object
app_id
string
config_versions
integer
created_at
string
created_by_id
string
dependencies
Array<string>
id
string
name
string
resolved_var_name
string
status
string
status_description
string
type
string
Allowed values: terraform_module helm_chart docker_build external_image job unknown
updated_at
string
var_name
string
component_id
string
created_at
string
created_by_id
string
id
string
install_deploys
Array<object>
object
action_workflow_runs
Array<object>
object
action_workflow_config_id
string
config
object
action_workflow_id
string
app_config_id
string
app_id
string
created_at
string
created_by_id
string
id
string
steps
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
command
string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
idx
integer
name

Metadata

string
previous_step_id
string
public_git_vcs_config

All the details needed for a step

object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
updated_at
string
timeout
integer
triggers
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
created_at
string
created_by_id
string
cron_schedule
string
id
string
type
string
updated_at
string
updated_at
string
created_at
string
created_by_id
string
execution_time
integer
id
string
install_action_workflow
object
action_workflow
object
app_id
string
config_count
integer
configs
Array<object>
object
action_workflow_id
string
app_config_id
string
app_id
string
created_at
string
created_by_id
string
id
string
steps
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
command
string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
idx
integer
name

Metadata

string
previous_step_id
string
public_git_vcs_config

All the details needed for a step

object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
updated_at
string
timeout
integer
triggers
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
created_at
string
created_by_id
string
cron_schedule
string
id
string
type
string
updated_at
string
updated_at
string
created_at
string
created_by_id
string
id
string
name

Metadata

string
status

TODO: change to default null after migration & after initial pr

string
status_description
string
updated_at
string
action_workflow_id
string
created_at
string
created_by_id
string
id
string
install_id
string
runs
Array<object> recursive
status

After query fields filled in after querying

string
updated_at
string
install_action_workflow_id
string
install_id
string
log_stream
object
attrs
object
key
additional properties
string
created_at
string
created_by_id
string
id
string
open
boolean
org_id
string
owner_id
string
owner_type
string
runner_api_url
string
updated_at
string
write_token
string
outputs
object
key
additional properties
any
run_env_vars
object
key
additional properties
string
runner_job
object
available_timeout

Available timeout is how long a job can be marked as “available” before being requeued

integer
created_at
string
created_by_id
string
execution_count
integer
execution_time
integer
execution_timeout

Execution timeout is how long a job can be marked as “exeucuting” before being requeued

integer
executions
Array<object>
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
key
additional properties
object
outputs_json
string
runner_job_execution_id
string
updated_at
string
result
object
created_at
string
created_by_id
string
error_code
integer
error_metadata
object
key
additional properties
string
id
string
org_id
string
runner_job_execution_id
string
success
boolean
updated_at
string
runner_job_id
string
status
string
Allowed values: pending initializing in-progress cleaning-up finished failed timed-out not-attempted cancelled unknown
updated_at
string
final_runner_job_execution_id
string
finished_at
string
group
string
Allowed values: health-checks sync build deploy sandbox runner operations actions "" any
id
string
log_stream_id
string
max_executions
integer
metadata
object
key
additional properties
string
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
string
outputs
object
key
additional properties
any
outputs_json
string
overall_timeout

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

integer
owner_id
string
owner_type
string
queue_timeout

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

integer
runner_id
string
started_at
string
status
string
Allowed values: queued available in-progress finished failed timed-out not-attempted cancelled unknown
status_description
string
type
string
Allowed values: 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 update-version noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow
updated_at
string
status
string
status_description
string
steps
Array<object>
object
created_at
string
created_by_id
string
execution_duration
integer
id
string
install_action_workflow_run_id
string
status
string
Allowed values: finished pending in-progress error
step_id
string
updated_at
string
trigger_type
string
Allowed values: manual cron pre-sandbox-run post-sandbox-run pre-deploy post-deploy
triggered_by_id
string
triggered_by_type
string
updated_at
string
build_id
string
component_config_version
integer
component_id
string
component_name
string
created_at
string
created_by_id
string
id
string
install_component_id
string
install_deploy_type
string
Allowed values: release install teardown plan-only
install_id

Fields that are de-nested at read time using AfterQuery

string
log_stream
object
attrs
object
key
additional properties
string
created_at
string
created_by_id
string
id
string
open
boolean
org_id
string
owner_id
string
owner_type
string
runner_api_url
string
updated_at
string
write_token
string
release_id
string
runner_jobs

Runner details

Array<object>
object
available_timeout

Available timeout is how long a job can be marked as “available” before being requeued

integer
created_at
string
created_by_id
string
execution_count
integer
execution_time
integer
execution_timeout

Execution timeout is how long a job can be marked as “exeucuting” before being requeued

integer
executions
Array<object>
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
key
additional properties
object
outputs_json
string
runner_job_execution_id
string
updated_at
string
result
object
created_at
string
created_by_id
string
error_code
integer
error_metadata
object
key
additional properties
string
id
string
org_id
string
runner_job_execution_id
string
success
boolean
updated_at
string
runner_job_id
string
status
string
Allowed values: pending initializing in-progress cleaning-up finished failed timed-out not-attempted cancelled unknown
updated_at
string
final_runner_job_execution_id
string
finished_at
string
group
string
Allowed values: health-checks sync build deploy sandbox runner operations actions "" any
id
string
log_stream_id
string
max_executions
integer
metadata
object
key
additional properties
string
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
string
outputs
object
key
additional properties
any
outputs_json
string
overall_timeout

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

integer
owner_id
string
owner_type
string
queue_timeout

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

integer
runner_id
string
started_at
string
status
string
Allowed values: queued available in-progress finished failed timed-out not-attempted cancelled unknown
status_description
string
type
string
Allowed values: 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 update-version noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow
updated_at
string
status
string
status_description
string
updated_at
string
install_id
string
status

After query fields filled in after querying

string
updated_at
string
install_events
Array<object>
object
created_at
string
created_by_id
string
id
string
install_id
string
operation
string
operation_name
string
operation_status
string
Allowed values: started finished noop failed
org_id
string
payload
object
key
additional properties
string
updated_at
string
install_inputs
Array<object>
object
app_input_config_id
string
created_at
string
created_by_id
string
id
string
install_id
string
org_id
string
redacted_values
object
key
additional properties
string
updated_at
string
values
object
key
additional properties
string
install_number
integer
install_sandbox_runs
Array<object>
object
action_workflow_runs
Array<object>
object
action_workflow_config_id
string
config
object
action_workflow_id
string
app_config_id
string
app_id
string
created_at
string
created_by_id
string
id
string
steps
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
command
string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
idx
integer
name

Metadata

string
previous_step_id
string
public_git_vcs_config

All the details needed for a step

object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
updated_at
string
timeout
integer
triggers
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
created_at
string
created_by_id
string
cron_schedule
string
id
string
type
string
updated_at
string
updated_at
string
created_at
string
created_by_id
string
execution_time
integer
id
string
install_action_workflow
object
action_workflow
object
app_id
string
config_count
integer
configs
Array<object>
object
action_workflow_id
string
app_config_id
string
app_id
string
created_at
string
created_by_id
string
id
string
steps
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
command
string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
env_vars
object
key
additional properties
string
id
string
idx
integer
name

Metadata

string
previous_step_id
string
public_git_vcs_config

All the details needed for a step

object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
updated_at
string
timeout
integer
triggers
Array<object>
object
action_workflow_config_id
string
app_config_id

This belongs to an app config id

string
app_id
string
created_at
string
created_by_id
string
cron_schedule
string
id
string
type
string
updated_at
string
updated_at
string
created_at
string
created_by_id
string
id
string
name

Metadata

string
status

TODO: change to default null after migration & after initial pr

string
status_description
string
updated_at
string
action_workflow_id
string
created_at
string
created_by_id
string
id
string
install_id
string
runs
Array<object> recursive
status

After query fields filled in after querying

string
updated_at
string
install_action_workflow_id
string
install_id
string
log_stream
object
attrs
object
key
additional properties
string
created_at
string
created_by_id
string
id
string
open
boolean
org_id
string
owner_id
string
owner_type
string
runner_api_url
string
updated_at
string
write_token
string
outputs
object
key
additional properties
any
run_env_vars
object
key
additional properties
string
runner_job
object
available_timeout

Available timeout is how long a job can be marked as “available” before being requeued

integer
created_at
string
created_by_id
string
execution_count
integer
execution_time
integer
execution_timeout

Execution timeout is how long a job can be marked as “exeucuting” before being requeued

integer
executions
Array<object>
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
key
additional properties
object
outputs_json
string
runner_job_execution_id
string
updated_at
string
result
object
created_at
string
created_by_id
string
error_code
integer
error_metadata
object
key
additional properties
string
id
string
org_id
string
runner_job_execution_id
string
success
boolean
updated_at
string
runner_job_id
string
status
string
Allowed values: pending initializing in-progress cleaning-up finished failed timed-out not-attempted cancelled unknown
updated_at
string
final_runner_job_execution_id
string
finished_at
string
group
string
Allowed values: health-checks sync build deploy sandbox runner operations actions "" any
id
string
log_stream_id
string
max_executions
integer
metadata
object
key
additional properties
string
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
string
outputs
object
key
additional properties
any
outputs_json
string
overall_timeout

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

integer
owner_id
string
owner_type
string
queue_timeout

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

integer
runner_id
string
started_at
string
status
string
Allowed values: queued available in-progress finished failed timed-out not-attempted cancelled unknown
status_description
string
type
string
Allowed values: 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 update-version noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow
updated_at
string
status
string
status_description
string
steps
Array<object>
object
created_at
string
created_by_id
string
execution_duration
integer
id
string
install_action_workflow_run_id
string
status
string
Allowed values: finished pending in-progress error
step_id
string
updated_at
string
trigger_type
string
Allowed values: manual cron pre-sandbox-run post-sandbox-run pre-deploy post-deploy
triggered_by_id
string
triggered_by_type
string
updated_at
string
app_sandbox_config
object
app_id
string
artifacts

Links are dynamically loaded using an after query

object
cloudformation_stack_template
string
deprovision_policy
string
provision_policy
string
trust_policy
string
aws_delegation_config

Cloud specific fields

object
app_sandbox_config_id
string
created_at
string
created_by_id
string
iam_role_arn
string
id
string
org_id
string
updated_at
string
aws_region_type
string
cloud_platform

Fields set via after query

string
connected_github_vcs_config
object
branch
string
component_config_id

Parent component

string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo
string
repo_name
string
repo_owner
string
updated_at
string
vcs_connection
object
created_at
string
created_by_id
string
github_install_id
string
id
string
updated_at
string
vcs_connection_commit
Array<object>
object
author_email
string
author_name
string
component_config_connection_id
string
created_at
string
created_by_id
string
id
string
message
string
sha
string
updated_at
string
vcs_connection_id
string
created_at
string
created_by_id
string
id
string
org_id
string
public_git_vcs_config
object
branch
string
component_config_id
string
component_config_type
string
created_at
string
created_by_id
string
directory
string
id
string
repo

Actual configuration

string
updated_at
string
terraform_version
string
updated_at
string
variables
object
key
additional properties
string
created_at
string
created_by_id
string
id
string
install_id
string
log_stream
object
attrs
object
key
additional properties
string
created_at
string
created_by_id
string
id
string
open
boolean
org_id
string
owner_id
string
owner_type
string
runner_api_url
string
updated_at
string
write_token
string
run_type
string
Allowed values: provision reprovision deprovision
runner_job

Runner details

object
available_timeout

Available timeout is how long a job can be marked as “available” before being requeued

integer
created_at
string
created_by_id
string
execution_count
integer
execution_time
integer
execution_timeout

Execution timeout is how long a job can be marked as “exeucuting” before being requeued

integer
executions
Array<object>
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
created_at
string
created_by_id
string
id
string
org_id
string
outputs
object
key
additional properties
object
outputs_json
string
runner_job_execution_id
string
updated_at
string
result
object
created_at
string
created_by_id
string
error_code
integer
error_metadata
object
key
additional properties
string
id
string
org_id
string
runner_job_execution_id
string
success
boolean
updated_at
string
runner_job_id
string
status
string
Allowed values: pending initializing in-progress cleaning-up finished failed timed-out not-attempted cancelled unknown
updated_at
string
final_runner_job_execution_id
string
finished_at
string
group
string
Allowed values: health-checks sync build deploy sandbox runner operations actions "" any
id
string
log_stream_id
string
max_executions
integer
metadata
object
key
additional properties
string
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
string
outputs
object
key
additional properties
any
outputs_json
string
overall_timeout

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

integer
owner_id
string
owner_type
string
queue_timeout

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

integer
runner_id
string
started_at
string
status
string
Allowed values: queued available in-progress finished failed timed-out not-attempted cancelled unknown
status_description
string
type
string
Allowed values: 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 update-version noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow
updated_at
string
status
string
status_description
string
updated_at
string
name
string
runner_id
string
runner_status
string
runner_status_description
string
sandbox_status
string
sandbox_status_description
string
status

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

string
status_description
string
updated_at
string

400

Bad Request

object
description
string
error
string
user_error
boolean

401

Unauthorized

object
description
string
error
string
user_error
boolean

403

Forbidden

object
description
string
error
string
user_error
boolean

404

Not Found

object
description
string
error
string
user_error
boolean

500

Internal Server Error

object
description
string
error
string
user_error
boolean