Skip to content
forgit api docs

Get workspace runner

GET
/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}

Get workspace runner by uuid.

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

runner_uuid
required
string

The runner uuid.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The workspace runner.

Media type application/json
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
Example 
{
  "state": {
    "status": "UNREGISTERED"
  }
}

404

Section titled “ 404 ”

The workspace runner was not found.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}