Update a runner

PUT

/api/v4/runners/{id}

Updates a specified runner.

Authorizations

http
oauth2

Parameters

Path Parameters

required

integer

The ID of a runner

Request Body

application/json

object

description

The description of the runner

string

nullable

active

Deprecated: Use paused instead. Flag indicating whether the runner is allowed to receive jobs

boolean

nullable

paused

Specifies if the runner should ignore new jobs

boolean

nullable

tag_list

The list of tags for a runner

Array<string>

nullable

run_untagged

Specifies if the runner can execute untagged jobs

boolean

nullable

locked

Specifies if the runner is locked

boolean

nullable

access_level

The access level of the runner

string

nullable

Allowed values: not_protected ref_protected

maximum_timeout

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

integer

nullable

maintenance_note

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

string

nullable

Responses

200

application/json

object

integer format: int64

description

string

ip_address

string

active

boolean

paused

boolean

is_shared

boolean

runner_type

string

name

string

online

boolean

created_by

object

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

created_at

string format: date-time

status

string

job_execution_status

string

tag_list

string

run_untagged

string

locked

string

maximum_timeout

string

access_level

string

version

string

revision

string

platform

string

architecture

string

contacted_at

string

maintenance_note

string

projects

object

integer format: int64

description

string

name

string

name_with_namespace

string

path

string

path_with_namespace

string

created_at

string format: date-time

default_branch

string

tag_list

Array<string>

topics

Array<string>

ssh_url_to_repo

string

http_url_to_repo

string

web_url

string

readme_url

string

forks_count

integer

license_url

string

license

object

key

string

name

string

nickname

string

html_url

string

source_url

string

avatar_url

string

star_count

integer

last_activity_at

string format: date-time

visibility

string

namespace

object

integer format: int64

name

string

path

string

kind

string

full_path

string

parent_id

integer format: int64

avatar_url

string

web_url

string

custom_attributes

object

key

string

value

string

repository_storage

string

groups

object

integer format: int64

web_url

string

name

string

Example

{
  "id": 8,
  "description": "test-1-20150125",
  "ip_address": "127.0.0.1",
  "active": true,
  "paused": false,
  "is_shared": true,
  "runner_type": "instance_type",
  "name": "test",
  "online": true,
  "created_by": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "created_at": "2025-05-03T00:00:00.000Z",
  "status": "online",
  "job_execution_status": "idle",
  "projects": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z",
    "default_branch": "main",
    "tag_list": [
      "tag"
    ],
    "topics": [
      "topic"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
    "http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
    "web_url": "https://gitlab.example.com/gitlab/gitlab",
    "readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
    "forks_count": 1,
    "license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
    "license": {
      "key": "gpl-3.0",
      "name": "GNU General Public License v3.0",
      "nickname": "GNU GPLv3",
      "html_url": "http://choosealicense.com/licenses/gpl-3.0"
    },
    "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
    "star_count": 1,
    "last_activity_at": "2013-09-30T13:46:02Z",
    "visibility": "public",
    "namespace": {
      "id": 2,
      "name": "project",
      "path": "my_project",
      "kind": "project",
      "full_path": "group/my_project",
      "parent_id": 1,
      "avatar_url": "https://example.com/avatar/12345",
      "web_url": "https://example.com/group/my_project"
    },
    "custom_attributes": {
      "key": "foo",
      "value": "bar"
    },
    "repository_storage": "default"
  },
  "groups": {
    "web_url": "http://gitlab.example.com/groups/diaspora",
    "name": "Diaspora"
  }
}

400

Bad Request

401

Unauthorized

403

No access granted

404

Runner not found