Skip to main content
GET
get runner settings

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and token.

Path Parameters

runner_id
string
required

runner ID

Response

OK

aws_auth_method
enum<string>
Available options:
iid,
sts
aws_cloudformation_stack_type
string
aws_instance_type
string

aws runner specifics runner-v2

aws_max_instance_lifetime
integer

Deprecated: instance refresh is now handled by a backend cron, not ASG MaxInstanceLifetime.

aws_tags
object
binary_version
string

configuration for managing the runner binary version (for mng mode, not the install runner)

container_image_tag
string
container_image_url
string

configuration for deploying the runner

container_max_uptime
integer
created_at
string
created_by_id
string
enable_logging
boolean
enable_metrics
boolean
enable_sentry
boolean
groups
string[]

the job loop groups the runner should poll for

heart_beat_timeout
integer

Various settings for the runner to handle internally

id
string
job_group_parallelism
object

JobGroupParallelism maps RunnerJobGroup names to max-in-flight counts for queue-based job routing. e.g., {"build": "2", "deploy": "1"}. Only used when parallel-runner-jobs feature flag is on.

local_aws_iam_role_arn
string
logging_level
string
long_poll_jobs
boolean

LongPollJobs mirrors the org's runner-job-long-poll feature flag so the runner can choose between the legacy idle-poll loop and the new long-poll endpoint at boot. Not persisted; populated by the runner-settings handler.

metadata
object

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

org_aws_iam_role_arn
string

org runner specifics

org_azure_client_id
string
org_gcp_service_account
string
org_id
string
org_k8s_service_account_name
string
otel_collector_config
string
platform
string

platform variable for use in the runner

runner_api_url
string
runner_binary_url
string

RunnerBinaryURL overrides the URL used to download the runner binary onto the host for mng mode. When empty, defaults to the S3 artifacts URL.

runner_group_id
string
sandbox_mode
boolean

configuration for managing the runner server side

updated_at
string
vm_max_uptime
integer