Create a runner owned by currently authenticated user

POST

/api/v4/user/runners

• GitLab REST API

Create a new runner

Authorizations

• http
• oauth2

Request Body ^required

Media type application/json

object

runner_type

required

Specifies the scope of the runner

string

>= 1 characters

Allowed values: instance_type group_type project_type

group_id

required

The ID of the group that the runner is created in

integer

nullable

Example

1

project_id

required

The ID of the project that the runner is created in

integer

nullable

Example

1

description

Description of the runner

string

nullable

maintenance_note

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

string

nullable

paused

Specifies if the runner should ignore new jobs (defaults to false)

boolean

nullable

locked

Specifies if the runner should be locked for the current project (defaults to false)

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 (defaults to true)

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

token_expires_at

The expiration time for the runner authentication token (ISO 8601 format). Must be between 5 minutes and 15 days in the future, and cannot exceed instance/group/project limits.

string format: date-time

nullable

token_rotation_deadline

The deadline for token rotation (ISO 8601 format). Must be specified with token_expires_at and be <= token_expires_at.

string format: date-time

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