GIgitlab
runners

Retrieve details on a runner

Retrieves details of a runner. Instance runner details are available to all authenticated users through this endpoint. For groups and projects, you must have the Maintainer or Owner role for the associated project or group.

get/api/v4/runners/{id}

Request

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

Path parameters

idinteger required

The ID of a runner

Query parameters

include_projectsboolean

Include projects in the response. Set to false to improve performance for runners with many projects.

Response

Retrieve details on a runner

idinteger required
descriptionstring required
ip_addressstring required
activeboolean required
pausedboolean required
is_sharedboolean required
runner_type'instance_type' | 'group_type' | 'project_type' required
namestring required
onlineboolean required
created_atstring date-time required
statusstring required
job_execution_status'active' | 'idle' required
tag_liststring required
run_untaggedstring required
lockedstring required
maximum_timeoutstring required
access_levelstring required
versionstring required
revisionstring required
platformstring required
architecturestring required
contacted_atstring required
maintenance_notestring required

Example response

{
  "id": 8,
  "description": "test-1-20150125",
  "ip_address": "127.0.0.1",
  "active": true,
  "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"
  }
}

Changes

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