Skip to content
forgit api docs

Get repository runners

GET
/repositories/{workspace}/{repo_slug}/pipelines-config/runners

Retrieve repository runners.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug
required
string

The repository.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The repository runners.

Media type application/json
Paginated Runners

A paged list of runners.

object
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
values

The values of the current page.

Array
0
object
type
required
string
uuid

The UUID identifying the runner.

string
name

The name of the runner.

string
labels

Labels assigned to the runner for identification and routing.

Array<string>
state
object
type
required
string
status

The current status of the runner.

string
Allowed values: UNREGISTERED ONLINE OFFLINE DISABLED ENABLED UNHEALTHY
version
object
type
required
string
version

The currently installed version of the runner.

string
current

The current recommended version of the runner.

string
updated_on

The timestamp when the runner state was last updated.

string format: date-time
cordoned

Whether the runner is cordoned (prevented from accepting new steps).

boolean
created_on

The timestamp when the runner was created.

string format: date-time
updated_on

The timestamp when the runner was last updated.

string format: date-time
oauth_client
object
type
required
string
id

The OAuth client ID.

string
secret

The OAuth client secret. This is an optional element that is only provided once.

string
token_endpoint

The OAuth token endpoint URL.

string format: uri
audience

The intended audience for the OAuth token.

string
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string
Example 
{
  "values": [
    {
      "state": {
        "status": "UNREGISTERED"
      }
    }
  ]
}