Create a runner

POST

/api/v4/runners

• GitLab REST API

Creates a runner.

Authorizations

• http
• oauth2

Request Body ^required

Media type application/json

object

token

required

Registration token

string

nullable

description

Description of the runner

string

nullable

maintainer_note

Deprecated: see maintenance_note

string

nullable

maintenance_note

Free-form maintenance notes for the runner (1024 characters)

string

nullable

info

Runner’s metadata

object

name

Runner’s name

string

nullable

version

Runner’s version

string

nullable

revision

Runner’s revision

string

nullable

platform

Runner’s platform

string

nullable

architecture

Runner’s architecture

string

nullable

active

Deprecated: Use paused instead. Specifies if the runner is allowed to receive new jobs

boolean

nullable

paused

Specifies if the runner should ignore new jobs

boolean

nullable

locked

Specifies if the runner should be locked for the current project

boolean

nullable

access_level

The access level of the runner

string

nullable

Allowed values: not_protected ref_protected

run_untagged

Specifies if the runner should handle untagged jobs

boolean

nullable

tag_list

A list of runner tags

Array<string>

nullable

maximum_timeout

Maximum timeout that limits the amount of time (in seconds) that runners can run jobs

integer

nullable

Responses

201

Created

Media type application/json

object

id

string

token

string

token_expires_at

string

Example ^generated

{
  "id": "example",
  "token": "example",
  "token_expires_at": "example"
}

400

Bad Request

403

Forbidden

410

Gone