create a new org

POST

/v1/orgs

Authorizations

• APIKey

Request Body

Input

object

name

required

string

use_sandbox_mode

These fields are used to control the behaviour of the org.

boolean

Responses

201

Created

object

created_at

string

created_by_id

string

health_checks

Array<object>

object

created_at

string

created_by_id

string

id

string

orgID

string

status

string

Allowed values: ok error in-progress provisioning deprovisioning

status_description

string

updated_at

string

id

string

latest_health_check

Filled in at read time

object

created_at

string

created_by_id

string

id

string

orgID

string

status

string

Allowed values: ok error in-progress provisioning deprovisioning

status_description

string

updated_at

string

logo_url

string

name

string

notifications_config

object

created_at

string

created_by_id

string

id

string

org_id

string

owner_id

string

owner_type

string

slack_webhook_url

string

updated_at

string

runner_group

object

created_at

string

created_by_id

string

id

string

org_id

string

owner_id

Parent can org, install or in the future, builtin runner group

string

owner_type

string

platform

string

Allowed values: aws-ecs aws-eks azure-aks azure-acs local

runners

Array<object>

object

created_at

string

created_by_id

string

display_name

string

id

string

jobs

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

operation

string

Allowed values: exec apply destroy plan-only build unknown

org_id

string

outputs

object

key

additional properties

any

outputs_json

Array<integer>

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 noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow

updated_at

string

name

string

operations

Array<object>

object

created_at

string

created_by_id

string

id

string

log_stream

Job details

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

operation_type

string

Allowed values: provision reprovision deprovision

runner_id

string

status

string

status_description

string

updated_at

string

org_id

string

runner_group_id

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

operation

string

Allowed values: exec apply destroy plan-only build unknown

org_id

string

outputs

object

key

additional properties

any

outputs_json

Array<integer>

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 noop sandbox-terraform runner-helm runner-terraform runner-local actions-workflow

updated_at

string

status

string

status_description

string

updated_at

string

settings

object

aws_iam_role_arn

Specific configuration for cloud specific runners, such as AWS or Azure

string

container_image_tag

string

container_image_url

Configuration for deploying the runner

string

created_at

string

created_by_id

string

enable_logging

boolean

enable_metrics

boolean

enable_sentry

boolean

heart_beat_timeout

Various settings for the runner to handle internally

integer

id

string

k8s_service_account_name

string

logging_level

string

metadata

Metadata is used as both log and metric tags/attributes in the runner when emitting data

object

key

additional properties

string

org_id

string

otel_collector_config

string

runner_api_url

string

runner_group_id

string

sandbox_mode

Configuration for managing the runner server side

boolean

updated_at

string

type

string

Allowed values: install org

updated_at

string

sandbox_mode

boolean

status

string

status_description

string

updated_at

string

vcs_connections

Array<object>

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

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