GIgitlab
users
runners

Create a runner owned by currently authenticated user

Create a new runner

post/api/v4/user/runners

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Request body

runner_type'instance_type' | 'group_type' | 'project_type' required

Specifies the scope of the runner

group_idinteger required

The ID of the group that the runner is created in

project_idinteger required

The ID of the project that the runner is created in

descriptionstring

Description of the runner

maintenance_notestring

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

pausedboolean

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

lockedboolean

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

access_level'not_protected' | 'ref_protected'

The access level of the runner

run_untaggedboolean

Specifies if the runner should handle untagged jobs (defaults to true)

tag_liststring[]

A list of runner tags

maximum_timeoutinteger

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

token_expires_atstring date-time

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

token_rotation_deadlinestring date-time

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

Example request

{
  "group_id": 1,
  "project_id": 1
}

Response

Create a runner owned by currently authenticated user

idstring required
tokenstring required
token_expires_atstring required

Changes

No recorded changes to this operation across all 5 revisions of this API.