Skip to content

get an installs sandbox runs

GET
/v1/installs/{install_id}/sandbox-runs

Authorizations

Parameters

Path Parameters

install_id
required
string

Install ID

Responses

200

OK

Array<object>
object
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_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
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

TODO(jm): add richer information on the error or other tied to a job execution.

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
group
string
Allowed values: health-checks sync build deploy sandbox runner operations user "" any
id
string
log_stream_id
string
max_executions
integer
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
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
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 noop sandbox-terraform runner-helm runner-terraform runner-local
updated_at
string
status
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