Skip to content

get runner settings

GET
/v1/runners/{runner_id}/settings

Return runner settings for the provided runner.

Authorizations

Parameters

Path Parameters

runner_id
required
string

Runner ID

Responses

200

OK

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

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