GET/admin/actions/runners/{runner_id}

Get an Action runner

Retrieves a specific Action runner regardless of whether it is global or scoped to an organization, user, or repository. Supply runner_id to identify the runner to retrieve. The response includes the runner's ownership, labels, status, UUID, and reported version.

1 parameter
runner_idstringrequired

The identifier of the Action runner to retrieve.

3 status codes
200Returns an Action runner object containing its identifier, name, description, ownership IDs, labels, status, UUID, ephemeral state, and reported version.
descriptionstringoptional

Description provides optional details about this runner.

ephemeralbooleanoptional

Indicates if runner is ephemeral runner

idintegeroptional

ID uniquely identifies this runner.

labelsarray<string>optional

Labels is a list of labels attached to this runner.

namestringoptional

Name of the runner; not unique.

owner_idintegeroptional

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

repo_idintegeroptional

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

statusstringoptional

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

Allowed:offlineidleactive
uuidstringoptional

UUID uniquely identifies this runner.

versionstringoptional

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

400Returned when runner_id has an invalid format.
messagestringoptional
urlstringoptional
404Returned when no runner exists with the supplied runner_id.
errorsarray<string>optional
messagestringoptional
urlstringoptional

Error handling

A 400 is returned when runner_id cannot be parsed as the expected runner identifier. A 404 is returned when no runner is found for the supplied runner_id. runner_id must identify the runner you want to retrieve.