Skip to content

Get all runners, no matter whether they are global runners or scoped to an organization, user, or repository

GET
/admin/actions/runners
visible
boolean

Whether to include all visible runners (true) or only those that are directly owned by the instance (false)

page
integer

Page number of results to return (1-based)

limit
integer

Page size of results

ActionRunnerList is a list of Forgejo Action runners

Media type application/json
Array<object>

ActionRunner represents a runner

object
description

Description provides optional details about this runner.

string
ephemeral

Indicates if runner is ephemeral runner

boolean
id

ID uniquely identifies this runner.

integer format: int64
labels

Labels is a list of labels attached to this runner.

Array<string>
name

Name of the runner; not unique.

string
owner_id

OwnerID is the identifier of the user or organization this runner belongs to. O if the runner is owned by a repository.

integer format: int64
repo_id

RepoID is the identifier of the repository this runner belongs to. 0 if the runner belongs to a user or organization.

integer format: int64
status

Status indicates whether this runner is offline, or active, for example.

string
Allowed values: offline idle active
uuid

UUID uniquely identifies this runner.

string
version

Version is the self-reported version string of Forgejo Runner.

string
Example
[
{
"status": "offline"
}
]
Link
string

Links to other pages, if any

X-Total-Count
integer format: int64

Total number of runners matching the search criteria (excluding page and limit)

APIError is error format response

Media type application/json

APIError is an api error with a message

object
message
string
url
string
Example generated
{
"message": "example",
"url": "example"
}

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated
{
"errors": [
"example"
],
"message": "example",
"url": "example"
}