Skip to content
forgit api docs

Get a particular runner that belongs to the organization

GET
/orgs/{org}/actions/runners/{runner_id}

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Name of the organization

runner_id
required
string

ID of the runner

Responses

Section titled “Responses”

200

Section titled “200”

ActionRunner represents a runner

Media typeapplication/json

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"
}

400

Section titled “400”

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object
message
string
url
string
Examplegenerated
{
  "message": "example",
  "url": "example"
}

404

Section titled “404”

APINotFound is a not found error response

Media typeapplication/json
object
errors
Array<string>
message
string
url
string
Examplegenerated
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}