Skip to main content
GET
/
v1
/
runners
/
{runner_id}
/
settings
get runner settings
curl --request GET \
  --url https://api.nuon.co/v1/runners/{runner_id}/settings \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.nuon.co/v1/runners/{runner_id}/settings"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.nuon.co/v1/runners/{runner_id}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nuon.co/v1/runners/{runner_id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.nuon.co/v1/runners/{runner_id}/settings"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.nuon.co/v1/runners/{runner_id}/settings")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.nuon.co/v1/runners/{runner_id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "aws_cloudformation_stack_type": "<string>",
  "aws_instance_type": "<string>",
  "aws_max_instance_lifetime": 123,
  "aws_tags": {},
  "binary_version": "<string>",
  "container_image_tag": "<string>",
  "container_image_url": "<string>",
  "container_max_uptime": 123,
  "created_at": "<string>",
  "created_by_id": "<string>",
  "enable_logging": true,
  "enable_metrics": true,
  "enable_sentry": true,
  "groups": [
    "<string>"
  ],
  "heart_beat_timeout": 123,
  "id": "<string>",
  "job_group_parallelism": {},
  "local_aws_iam_role_arn": "<string>",
  "logging_level": "<string>",
  "long_poll_jobs": true,
  "metadata": {},
  "org_aws_iam_role_arn": "<string>",
  "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>",
  "runner_api_url": "<string>",
  "runner_binary_url": "<string>",
  "runner_group_id": "<string>",
  "sandbox_mode": true,
  "updated_at": "<string>",
  "vm_max_uptime": 123
}
{
"description": "<string>",
"error": "<string>",
"user_error": true
}
{
"description": "<string>",
"error": "<string>",
"user_error": true
}
{
"description": "<string>",
"error": "<string>",
"user_error": true
}
{
"description": "<string>",
"error": "<string>",
"user_error": true
}
{
"description": "<string>",
"error": "<string>",
"user_error": true
}

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