Workers

List Worker Configs

List worker configurations in a namespace, grouped by worker name and datacenter.

Filter by variant to return only normal or serverless configurations. Use runner_name for multiple names because runner_names is deprecated.

GET https://api.rivet.dev/runner-configs

Examples

curl "https://api.rivet.dev/runner-configs?namespace=$RIVET_NAMESPACE" \
  -H "Authorization: Bearer $RIVET_TOKEN"

const endpoint = "https://api.rivet.dev";
const namespace = process.env.RIVET_NAMESPACE ?? "default";
const token = process.env.RIVET_TOKEN ?? "";

const params = new URLSearchParams({ namespace });
const response = await fetch(`${endpoint}/runner-configs?${params}`, {
	headers: { Authorization: `Bearer ${token}` },
});
const { runner_configs } = await response.json();
console.log(runner_configs);

export {};

Authentication

Send your namespace token as a bearer token in the Authorization header. Every control plane request also requires the namespace query parameter. See Authentication.

Query Parameters

Name	Type	Required	Description
`namespace`	`string`	Yes	Name of the namespace to operate in.
`limit`	`integer`	No	Maximum number of results to return.
`cursor`	`string`	No	Pagination cursor. Pass the `pagination.cursor` value from the previous response to fetch the next page.
`variant`	`string`	No	Only return configurations with this variant. One of `"serverless"`, `"normal"`.
`runner_names`	`string`	No	Deprecated. Use `runner_name` instead.
`runner_name`	`string[]`	No	Only return configurations for these worker names. Repeat the parameter for multiple names.

Responses

200

Worker configurations grouped by worker name and datacenter.

Field	Type	Description
`pagination`	`object`
`pagination.cursor`	`string \| null`	Cursor for the next page, or `null` when there are no more results.
`runner_configs`	`object`

{
  "pagination": {
    "cursor": null
  },
  "runner_configs": {}
}