[Skip to main content](https://docs.gitlab.com/api/runners/#skipTarget) [Go to GitLab Docs homepage](https://docs.gitlab.com/)
`/`
[What's new?](https://about.gitlab.com/releases/whats-new/)
English
  * Language
  * English
  * 日本語


v18.10
  *     * [18.10 (not yet released)](https://docs.gitlab.com/api/runners/)
  *     * [18.9 (recently released)](https://docs.gitlab.com/18.9/api/runners/)
    * [18.8](https://docs.gitlab.com/18.8/api/runners/)
    * [18.7](https://archives.docs.gitlab.com/18.7/api/runners/)
  *     * [17.11](https://archives.docs.gitlab.com/17.11/api/runners/)
    * [16.11](https://archives.docs.gitlab.com/16.11/ee/api/runners.html)
  *     * [Archives](https://docs.gitlab.com/archives)


Select theme and layout
  * Light mode
  * Dark mode
  * Auto


  * Fixed width
  * Fluid width


[What's new?](https://about.gitlab.com/releases/whats-new/) [Get free trial](https://gitlab.com/-/trial_registrations/new?glm_source=docs.gitlab.com&amp;glm_content=navigation-cta-docs)
Toggle menu
  * [Use GitLab](https://docs.gitlab.com/user/)
  * [GitLab Duo](https://docs.gitlab.com/user/gitlab_duo/)
  * [Extend](https://docs.gitlab.com/api/)
  * [Install](https://docs.gitlab.com/install/)
  * [Administer](https://docs.gitlab.com/administration/)
  * [Subscribe](https://docs.gitlab.com/subscriptions/)
  * [Contribute](https://docs.gitlab.com/development/)
  * [Solutions](https://docs.gitlab.com/solutions/)


Select a topicUse GitLab GitLab Duo Extend Install Administer Subscribe Contribute Solutions
[Getting started](https://docs.gitlab.com/api/get_started/get_started_extending/)
[Tutorials](https://docs.gitlab.com/tutorials/develop/)
[Integrations](https://docs.gitlab.com/integration/)
[Webhooks](https://docs.gitlab.com/user/project/integrations/webhooks/)
[REST API](https://docs.gitlab.com/api/rest/)
[Resources](https://docs.gitlab.com/api/api_resources/)
[.gitignore (templates)](https://docs.gitlab.com/api/templates/gitignores/)
[.gitlab-ci.yml (templates)](https://docs.gitlab.com/api/templates/gitlab_ci_ymls/)
[Access requests](https://docs.gitlab.com/api/access_requests/)
[Agent for Kubernetes](https://docs.gitlab.com/api/cluster_agents/)
[AI Catalog admin](https://docs.gitlab.com/api/admin/ai_catalog/)
[Alert management](https://docs.gitlab.com/api/alert_management_alerts/)
[Application appearance](https://docs.gitlab.com/api/appearance/)
[Application settings](https://docs.gitlab.com/api/settings/)
[Application statistics](https://docs.gitlab.com/api/statistics/)
[Applications](https://docs.gitlab.com/api/applications/)
[Attestations](https://docs.gitlab.com/api/attestations/)
[Audit events](https://docs.gitlab.com/api/audit_events/)
[Avatar](https://docs.gitlab.com/api/avatar/)
[Branches](https://docs.gitlab.com/api/branches/)
[Broadcast messages](https://docs.gitlab.com/api/broadcast_messages/)
[Cluster discovery (certificate-based) (deprecated)](https://docs.gitlab.com/api/cluster_discovery/)
[Code Suggestions](https://docs.gitlab.com/api/code_suggestions/)
[Commits](https://docs.gitlab.com/api/commits/)
[Compliance and policy settings](https://docs.gitlab.com/api/compliance_policy_settings/)
[Composer](https://docs.gitlab.com/api/packages/composer/)
[Conan v1](https://docs.gitlab.com/api/packages/conan_v1/)
[Conan v2](https://docs.gitlab.com/api/packages/conan_v2/)
[Container registry](https://docs.gitlab.com/api/container_registry/)
[Container repository protection rules](https://docs.gitlab.com/api/container_repository_protection_rules/)
[Container registry protection tag rules](https://docs.gitlab.com/api/container_registry_protection_tag_rules/)
[Container virtual registry](https://docs.gitlab.com/api/container_virtual_registries/)
[Custom attributes](https://docs.gitlab.com/api/custom_attributes/)
[Database migrations](https://docs.gitlab.com/api/database_migrations/)
[Data management](https://docs.gitlab.com/api/admin/data_management/)
[Debian](https://docs.gitlab.com/api/packages/debian/)
[Debian group distributions](https://docs.gitlab.com/api/packages/debian_group_distributions/)
[Debian project distributions](https://docs.gitlab.com/api/packages/debian_project_distributions/)
[Dependencies](https://docs.gitlab.com/api/dependencies/)
[Dependency list export](https://docs.gitlab.com/api/dependency_list_export/)
[Dependency Proxy](https://docs.gitlab.com/api/dependency_proxy/)
[Deploy keys](https://docs.gitlab.com/api/deploy_keys/)
[Deploy tokens](https://docs.gitlab.com/api/deploy_tokens/)
[Deployments](https://docs.gitlab.com/api/deployments/)
[Discussions](https://docs.gitlab.com/api/discussions/)
[Dockerfile (templates)](https://docs.gitlab.com/api/templates/dockerfiles/)
[DORA4 metrics](https://docs.gitlab.com/api/dora/metrics/)
[Emoji reactions](https://docs.gitlab.com/api/emoji_reactions/)
[Environments](https://docs.gitlab.com/api/environments/)
[Epics (deprecated)](https://docs.gitlab.com/api/epics/)
[Error tracking](https://docs.gitlab.com/api/error_tracking/)
[Events](https://docs.gitlab.com/api/events/)
[Experiments](https://docs.gitlab.com/api/experiments/)
[External status checks](https://docs.gitlab.com/api/status_checks/)
[Feature flags](https://docs.gitlab.com/api/feature_flags/)
[Feature flag user lists](https://docs.gitlab.com/api/feature_flag_user_lists/)
[Freeze periods](https://docs.gitlab.com/api/freeze_periods/)
[Geo nodes (deprecated)](https://docs.gitlab.com/api/geo_nodes/)
[Geo sites](https://docs.gitlab.com/api/geo_sites/)
[GitLab Duo Chat completions](https://docs.gitlab.com/api/chat/)
[GitLab Pages](https://docs.gitlab.com/api/pages/)
[GLQL](https://docs.gitlab.com/api/glql/)
[Go Proxy](https://docs.gitlab.com/api/packages/go_proxy/)
[Google Cloud integration](https://docs.gitlab.com/api/google_cloud_integration/)
[Groups](https://docs.gitlab.com/api/groups/)
[Helm](https://docs.gitlab.com/api/packages/helm/)
[Import](https://docs.gitlab.com/api/import/)
[Instance CI/CD variables](https://docs.gitlab.com/api/instance_level_ci_variables/)
[Invitations](https://docs.gitlab.com/api/invitations/)
[Issues](https://docs.gitlab.com/api/issues/)
[Issues (epic) (deprecated)](https://docs.gitlab.com/api/epic_issues/)
[Issues statistics](https://docs.gitlab.com/api/issues_statistics/)
[Jobs](https://docs.gitlab.com/api/jobs/)
[Job artifacts](https://docs.gitlab.com/api/job_artifacts/)
[Job token scopes](https://docs.gitlab.com/api/project_job_token_scopes/)
[Keys](https://docs.gitlab.com/api/keys/)
[License](https://docs.gitlab.com/api/license/)
[Licenses (templates)](https://docs.gitlab.com/api/templates/licenses/)
[Linked epics (deprecated)](https://docs.gitlab.com/api/linked_epics/)
[Links (issue)](https://docs.gitlab.com/api/issue_links/)
[Links (epic) (deprecated)](https://docs.gitlab.com/api/epic_links/)
[Lint .gitlab-ci.yml](https://docs.gitlab.com/api/lint/)
[Markdown](https://docs.gitlab.com/api/markdown/)
[Maven](https://docs.gitlab.com/api/packages/maven/)
[Maven virtual registry](https://docs.gitlab.com/api/maven_virtual_registries/)
[Member roles](https://docs.gitlab.com/api/member_roles/)
[Merge request approvals](https://docs.gitlab.com/api/merge_request_approvals/)
[Merge request approval settings](https://docs.gitlab.com/api/merge_request_approval_settings/)
[Merge request context commits](https://docs.gitlab.com/api/merge_request_context_commits/)
[Merge requests](https://docs.gitlab.com/api/merge_requests/)
[Merge trains](https://docs.gitlab.com/api/merge_trains/)
[Metadata](https://docs.gitlab.com/api/metadata/)
[Model registry](https://docs.gitlab.com/api/model_registry/)
[Namespaces](https://docs.gitlab.com/api/namespaces/)
[Notes (comments)](https://docs.gitlab.com/api/notes/)
[Notification settings](https://docs.gitlab.com/api/notification_settings/)
[npm](https://docs.gitlab.com/api/packages/npm/)
[NuGet](https://docs.gitlab.com/api/packages/nuget/)
[Organizations](https://docs.gitlab.com/api/organizations/)
[Packages](https://docs.gitlab.com/api/packages/)
[Pages domains](https://docs.gitlab.com/api/pages_domains/)
[Personal access tokens](https://docs.gitlab.com/api/personal_access_tokens/)
[Pipeline schedules](https://docs.gitlab.com/api/pipeline_schedules/)
[Pipeline trigger tokens](https://docs.gitlab.com/api/pipeline_triggers/)
[Pipelines](https://docs.gitlab.com/api/pipelines/)
[Plan limits](https://docs.gitlab.com/api/plan_limits/)
[Product analytics](https://docs.gitlab.com/api/product_analytics/)
[Projects](https://docs.gitlab.com/api/projects/)
[PyPI](https://docs.gitlab.com/api/packages/pypi/)
[Repositories](https://docs.gitlab.com/api/repositories/)
[Repository files](https://docs.gitlab.com/api/repository_files/)
[Repository submodules](https://docs.gitlab.com/api/repository_submodules/)
[Resource group](https://docs.gitlab.com/api/resource_groups/)
[Resource iteration events](https://docs.gitlab.com/api/resource_iteration_events/)
[Resource label events](https://docs.gitlab.com/api/resource_label_events/)
[Resource milestone events](https://docs.gitlab.com/api/resource_milestone_events/)
[Resource state events](https://docs.gitlab.com/api/resource_state_events/)
[Resource weight events](https://docs.gitlab.com/api/resource_weight_events/)
[Ruby gems](https://docs.gitlab.com/api/packages/rubygems/)
[Runners](https://docs.gitlab.com/api/runners/)
[Runner controllers](https://docs.gitlab.com/api/runner_controllers/)
[Runner controller tokens](https://docs.gitlab.com/api/runner_controller_tokens/)
[Search](https://docs.gitlab.com/api/search/)
[Search migrations](https://docs.gitlab.com/api/search_admin/)
[Secure files](https://docs.gitlab.com/api/secure_files/)
[Service accounts](https://docs.gitlab.com/api/service_accounts/)
[Service Ping](https://docs.gitlab.com/api/usage_data/)
[Sidekiq metrics](https://docs.gitlab.com/api/sidekiq_metrics/)
[Sidekiq queues](https://docs.gitlab.com/api/admin_sidekiq_queues/)
[Snippet repository storage moves](https://docs.gitlab.com/api/snippet_repository_storage_moves/)
[Snippets](https://docs.gitlab.com/api/snippets/)
[Suggestions](https://docs.gitlab.com/api/suggestions/)
[System hooks](https://docs.gitlab.com/api/system_hooks/)
[Tags](https://docs.gitlab.com/api/tags/)
[Terraform registry](https://docs.gitlab.com/api/packages/terraform-modules/)
[To-Do List](https://docs.gitlab.com/api/todos/)
[Token information](https://docs.gitlab.com/api/admin/token/)
[Topics](https://docs.gitlab.com/api/topics/)
[Users](https://docs.gitlab.com/api/users/)
[Version](https://docs.gitlab.com/api/version/)
[Virtual registries cleanup policies](https://docs.gitlab.com/api/virtual_registries_cleanup_policies/)
[Vulnerabilities](https://docs.gitlab.com/api/vulnerabilities/)
[Vulnerability archive export](https://docs.gitlab.com/api/vulnerability_archive_exports/)
[Vulnerability export](https://docs.gitlab.com/api/vulnerability_exports/)
[Vulnerability findings](https://docs.gitlab.com/api/vulnerability_findings/)
[Web commits](https://docs.gitlab.com/api/web_commits/)
[Authentication](https://docs.gitlab.com/api/rest/authentication/)
[Third-party clients](https://docs.gitlab.com/api/rest/third_party_clients/)
[Deprecations and removals](https://docs.gitlab.com/api/rest/deprecations/)
[OpenAPI](https://docs.gitlab.com/api/openapi/openapi_interactive/)
[Automate storage management](https://docs.gitlab.com/user/storage_management_automation/)
[Troubleshooting](https://docs.gitlab.com/api/rest/troubleshooting/)
[GraphQL API](https://docs.gitlab.com/api/graphql/)
[OAuth 2.0 identity provider API](https://docs.gitlab.com/api/oauth2/)
[GitLab Duo CLI (duo)](https://docs.gitlab.com/user/gitlab_duo_cli/)
[GitLab CLI (glab)](https://docs.gitlab.com/cli/)
[Editor and IDE extensions](https://docs.gitlab.com/editor_extensions/)
/
  1. [GitLab Docs](https://docs.gitlab.com/)
  2. [Extend](https://docs.gitlab.com/api/)
  3. [REST API](https://docs.gitlab.com/api/rest/)
  4. [Resources](https://docs.gitlab.com/api/api_resources/)
  5. [Runners](https://docs.gitlab.com/api/runners/)


* * *
# Runners API
  * Tier: Free, Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


Use this API to manage [runners](https://docs.gitlab.com/ci/runners/) registered to an instance.
To create new instance, group, or project runners, use the [`POST /user/runners`](https://docs.gitlab.com/api/users/#create-a-runner-linked-to-a-user) endpoint. Use this API to manage existing runners.
[Pagination](https://docs.gitlab.com/api/rest/#pagination) is available on the following API endpoints (they return 20 items by default):
```
GET /runners
GET /runners/all
GET /runners/:id/jobs
GET /projects/:id/runners
GET /groups/:id/runners
```

## Registration and authentication tokens[](https://docs.gitlab.com/api/runners/#registration-and-authentication-tokens "Permalink")
To connect a runner with GitLab, you need two tokens.
Token | Description
---|---
Registration token (legacy) | Token used to [register the runner](https://docs.gitlab.com/runner/register/). It can be [obtained through GitLab](https://docs.gitlab.com/ci/runners/).
Authentication token | Token used to authenticate the runner with the GitLab instance. The token is obtained automatically when you [register a runner](https://docs.gitlab.com/runner/register/) or by the Runners API when you manually [register a runner](https://docs.gitlab.com/api/runners/#create-a-runner) or [reset the authentication token](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-runner-id). You can also obtain the token by using the [`POST /user/runners`](https://docs.gitlab.com/api/users/#create-a-runner-linked-to-a-user) endpoint.
Here’s an example of how you can use the tokens for runner registration:
  1. Register the runner by using the GitLab API with a registration token to receive an authentication token.
  2. Add the authentication token to the [runner’s configuration file](https://docs.gitlab.com/runner/commands/#configuration-file):
toml
```
[[runners]]
  token = "<authentication_token>"
```



GitLab and the runner are then connected.
## List all available runners[](https://docs.gitlab.com/api/runners/#list-all-available-runners "Permalink")
Lists all runners available to the user.
Prerequisites:
  * For group runners, you must have the Owner role in the owner namespace.
  * For project runners, you must have the Maintainer or Owner role in a project assigned to the runner.


```
GET /runners
GET /runners?scope=active
GET /runners?type=project_type
GET /runners?status=online
GET /runners?paused=true
GET /runners?tag_list=tag1,tag2
```

Attribute | Type | Required | Description
---|---|---|---
`scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to return, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided
`type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type`
`status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, or `never_contacted`.
Other possible values are the deprecated `active` and `paused`.
Requesting `offline` runners might also return `stale` runners because `stale` is included in `offline`.
`paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs
`tag_list` | string array | no | A list of runner tags
`version_prefix` | string | no | The prefix of the version of the runners to return. For example, `15.0`, `14`, `16.1.241`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners"
```

Deprecations:
  * The `active` and `paused` values in the `status` query parameter are deprecated and scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` query parameter instead.
  * The `active` attribute in the response is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.
  * The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab 17.0, this attribute returns an empty string. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).


Example response:
json
```
[
    {
        "active": true,
        "paused": false,
        "description": "test-1-20150125",
        "id": 6,
        "ip_address": "",
        "is_shared": false,
        "runner_type": "project_type",
        "name": null,
        "online": true,
        "status": "online"
    },
    {
        "active": true,
        "paused": false,
        "description": "test-2-20150125",
        "id": 8,
        "ip_address": "",
        "is_shared": false,
        "runner_type": "group_type",
        "name": null,
        "online": false,
        "status": "offline"
    }
]
```

## List all runners[](https://docs.gitlab.com/api/runners/#list-all-runners "Permalink")
  * Tier: Free, Premium, Ultimate
  * Offering: GitLab Self-Managed, GitLab Dedicated


Lists all runners in the GitLab instance (project and shared).
Prerequisites:
  * You must have either administrator access or auditor access.


```
GET /runners/all
GET /runners/all?scope=online
GET /runners/all?type=project_type
GET /runners/all?status=online
GET /runners/all?paused=true
GET /runners/all?tag_list=tag1,tag2
```

Attribute | Type | Required | Description
---|---|---|---
`scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to return, one of: `specific`, `shared`, `active`, `paused`, `online` and `offline`; showing all runners if none provided
`type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type`
`status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, or `never_contacted`.
Other possible values are the deprecated `active` and `paused`.
Requesting `offline` runners might also return `stale` runners because `stale` is included in `offline`.
`paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs
`tag_list` | string array | no | A list of runner tags
`version_prefix` | string | no | The prefix of the version of the runners to return. For example, `15.0`, `16.1.241`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/all"
```

Deprecations:
  * The `active` and `paused` values in the `status` query parameter are deprecated and scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` query parameter instead.
  * The `active` attribute in the response is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.
  * The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab 17.0, this attribute returns an empty string. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).


Example response:
json
```
[
    {
        "active": true,
        "paused": false,
        "description": "shared-runner-1",
        "id": 1,
        "ip_address": "",
        "is_shared": true,
        "runner_type": "instance_type",
        "name": null,
        "online": true,
        "status": "online"
    },
    {
        "active": true,
        "paused": false,
        "description": "shared-runner-2",
        "id": 3,
        "ip_address": "",
        "is_shared": true,
        "runner_type": "instance_type",
        "name": null,
        "online": false,
        "status": "offline"
    },
    {
        "active": true,
        "paused": false,
        "description": "test-1-20150125",
        "id": 6,
        "ip_address": "",
        "is_shared": false,
        "runner_type": "project_type",
        "name": null,
        "online": true,
        "status": "paused"
    },
    {
        "active": true,
        "paused": false,
        "description": "test-2-20150125",
        "id": 8,
        "ip_address": "",
        "is_shared": false,
        "runner_type": "group_type",
        "name": null,
        "online": false,
        "status": "offline"
    }
]
```

To view more than the first 20 runners, use [pagination](https://docs.gitlab.com/api/rest/#pagination).
## Retrieve runner’s details[](https://docs.gitlab.com/api/runners/#retrieve-runners-details "Permalink")
Retrieves details of a runner.
Instance runner details are available to all authenticated users through this endpoint.
Prerequisites:
  * User access: You must have one of the following:
    * For group runners: The Maintainer or Owner role in the owner namespace.
    * For project runners: The Maintainer or Owner role in the project that owns the runner.
    * A custom role with the `admin_runners` permission in the relevant group or project.
  * An access token with the `manage_runner` scope and the appropriate role.


```
GET /runners/:id
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of a runner
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6"
```

Deprecations:
  * The `active` attribute in the response is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.
  * The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab 17.0, this attribute returns an empty string. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).
  * The `version`, `revision`, `platform`, and `architecture` attributes in the response are deprecated [in GitLab 17.0](https://gitlab.com/gitlab-org/gitlab/-/issues/457128) and are scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). The same attributes can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).


Example response:
json
```
{
    "active": true,
    "paused": false,
    "architecture": null,
    "description": "test-1-20150125",
    "id": 6,
    "ip_address": "",
    "is_shared": false,
    "runner_type": "project_type",
    "contacted_at": "2016-01-25T16:39:48.066Z",
    "maintenance_note": null,
    "name": null,
    "online": true,
    "status": "online",
    "platform": null,
    "projects": [
        {
            "id": 1,
            "name": "GitLab Community Edition",
            "name_with_namespace": "GitLab.org / GitLab Community Edition",
            "path": "gitlab-foss",
            "path_with_namespace": "gitlab-org/gitlab-foss"
        }
    ],
    "revision": null,
    "tag_list": [
        "ruby",
        "mysql"
    ],
    "version": null,
    "access_level": "ref_protected",
    "maximum_timeout": 3600
}
```

## Update runner’s details[](https://docs.gitlab.com/api/runners/#update-runners-details "Permalink")
Updates details of a runner.
```
PUT /runners/:id
```

Prerequisites:
  * User access: You must have one of the following:
    * For instance runners: Administrator access to the GitLab instance.
    * For group runners: Owner role in the owner namespace.
    * For project runners: The Maintainer or Owner role in a project assigned to the runner.
    * A custom role with the `admin_runners` permission in the relevant group or project.
  * An access token with the `manage_runner` scope and the appropriate role.

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of a runner
`description` | string | no | The description of the runner
`active` | boolean | no | Deprecated: Use `paused` instead. Flag indicating whether the runner is allowed to receive jobs
`paused` | boolean | no | Specifies if the runner should ignore new jobs
`tag_list` | array | no | The list of tags for the runner
`run_untagged` | boolean | no | Specifies if the runner can execute untagged jobs
`locked` | boolean | no | Specifies if the runner is locked
`access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected`
`maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs
`maintenance_note` | string | no | Free-form maintenance notes for the runner (1024 characters)
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6" \
     --form "description=test-1-20150125-test" --form "tag_list=ruby,mysql,tag1,tag2"
```

Deprecations:
  * The `active` query parameter is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.
  * The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab 17.0, this attribute returns an empty string. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).


Example response:
json
```
{
    "active": true,
    "architecture": null,
    "description": "test-1-20150125-test",
    "id": 6,
    "ip_address": "",
    "is_shared": false,
    "runner_type": "group_type",
    "contacted_at": "2016-01-25T16:39:48.066Z",
    "maintenance_note": null,
    "name": null,
    "online": true,
    "status": "online",
    "platform": null,
    "projects": [
        {
            "id": 1,
            "name": "GitLab Community Edition",
            "name_with_namespace": "GitLab.org / GitLab Community Edition",
            "path": "gitlab-foss",
            "path_with_namespace": "gitlab-org/gitlab-foss"
        }
    ],
    "revision": null,
    "tag_list": [
        "ruby",
        "mysql",
        "tag1",
        "tag2"
    ],
    "version": null,
    "access_level": "ref_protected",
    "maximum_timeout": null
}
```

### Pause a runner[](https://docs.gitlab.com/api/runners/#pause-a-runner "Permalink")
Pause a runner.
Prerequisites:
  * User access: You must have one of the following:
    * For instance runners: Administrator access to the GitLab instance.
    * For group runners: Owner role in the owner namespace.
    * For project runners: The Maintainer or Owner role in a project assigned to the runner.
    * A custom role with the `admin_runners` permission in the relevant group or project.
  * An access token with the `manage_runner` scope and the appropriate role.


```
PUT --form "paused=true" /runners/:runner_id

# --or--

# Deprecated: removal planned in 16.0
PUT --form "active=false" /runners/:runner_id
```

Attribute | Type | Required | Description
---|---|---|---
`runner_id` | integer | yes | The ID of a runner
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --form "paused=true"  "https://gitlab.example.com/api/v4/runners/6"

# --or--

# Deprecated: removal planned in 16.0
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --form "active=false"  "https://gitlab.example.com/api/v4/runners/6"
```

The `active` form attribute is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.
## List all jobs processed by a runner[](https://docs.gitlab.com/api/runners/#list-all-jobs-processed-by-a-runner "Permalink")
Lists all jobs that are being processed or were processed by the specified runner. The list of jobs is limited to projects where the user has the Reporter, Developer, Maintainer, or Owner role.
```
GET /runners/:id/jobs
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of a runner
`system_id` | string | no | System ID of the machine where the runner manager is running
`status` | string | no | Status of the job; one of: `running`, `success`, `failed`, `canceled`
`order_by` | string | no | Order jobs by `id`
`sort` | string | no | Sort jobs in `asc` or `desc` order (default: `desc`). If `sort` is specified, `order_by` must be specified as well
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/1/jobs?status=running"
```

Example response:
json
```
[
    {
        "id": 2,
        "status": "running",
        "stage": "test",
        "name": "test",
        "ref": "main",
        "tag": false,
        "coverage": null,
        "created_at": "2017-11-16T08:50:29.000Z",
        "started_at": "2017-11-16T08:51:29.000Z",
        "finished_at": "2017-11-16T08:53:29.000Z",
        "duration": 120,
        "queued_duration": 2,
        "user": {
            "id": 1,
            "name": "John Doe2",
            "username": "user2",
            "state": "active",
            "avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
            "web_url": "http://localhost/user2",
            "created_at": "2017-11-16T18:38:46.000Z",
            "bio": null,
            "location": null,
            "public_email": "",
            "linkedin": "",
            "twitter": "",
            "website_url": "",
            "organization": null
        },
        "commit": {
            "id": "97de212e80737a608d939f648d959671fb0a0142",
            "short_id": "97de212e",
            "title": "Update configuration\r",
            "created_at": "2017-11-16T08:50:28.000Z",
            "parent_ids": [
                "1b12f15a11fc6e62177bef08f47bc7b5ce50b141",
                "498214de67004b1da3d820901307bed2a68a8ef6"
            ],
            "message": "See merge request !123",
            "author_name": "John Doe2",
            "author_email": "user2@example.org",
            "authored_date": "2017-11-16T08:50:27.000Z",
            "committer_name": "John Doe2",
            "committer_email": "user2@example.org",
            "committed_date": "2017-11-16T08:50:27.000Z"
        },
        "pipeline": {
            "id": 2,
            "sha": "97de212e80737a608d939f648d959671fb0a0142",
            "ref": "main",
            "status": "running"
        },
        "project": {
            "id": 1,
            "description": null,
            "name": "project1",
            "name_with_namespace": "John Doe2 / project1",
            "path": "project1",
            "path_with_namespace": "namespace1/project1",
            "created_at": "2017-11-16T18:38:46.620Z"
        }
    }
]
```

## List all runner’s managers[](https://docs.gitlab.com/api/runners/#list-all-runners-managers "Permalink")
Lists all the managers of a runner.
```
GET /runners/:id/managers
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of a runner
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/1/managers"
```

Example response:
json
```
[
    {
      "id": 1,
      "system_id": "s_89e5e9956577",
      "version": "16.11.1",
      "revision": "535ced5f",
      "platform": "linux",
      "architecture": "amd64",
      "created_at": "2024-06-09T11:12:02.507Z",
      "contacted_at": "2024-06-09T06:30:09.355Z",
      "ip_address": "127.0.0.1",
      "status": "offline"
    },
    {
      "id": 2,
      "system_id": "runner-2",
      "version": "16.11.0",
      "revision": "91a27b2a",
      "platform": "linux",
      "architecture": "amd64",
      "created_at": "2024-06-09T09:12:02.507Z",
      "contacted_at": "2024-06-09T06:30:09.355Z",
      "ip_address": "127.0.0.1",
      "status": "offline"
    }
]
```

## List all of a project’s runners[](https://docs.gitlab.com/api/runners/#list-all-of-a-projects-runners "Permalink")
Lists all runners available in the project, including from ancestor groups and [any allowed instance runners](https://docs.gitlab.com/ci/runners/runners_scope/#enable-instance-runners-for-a-project).
Prerequisites:
  * You must be an administrator of the GitLab instance or have at least the Maintainer or Auditor role for the target project.


```
GET /projects/:id/runners
GET /projects/:id/runners?scope=active
GET /projects/:id/runners?type=project_type
GET /projects/:id/runners?status=online
GET /projects/:id/runners?paused=true
GET /projects/:id/runners?tag_list=tag1,tag2
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to return, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided
`type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type`
`status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, or `never_contacted`.
Other possible values are the deprecated `active` and `paused`.
Requesting `offline` runners might also return `stale` runners because `stale` is included in `offline`.
`paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs
`tag_list` | string array | no | A list of runner tags
`version_prefix` | string | no | The prefix of the version of the runners to return. For example, `15.0`, `14`, `16.1.241`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners"
```

Deprecations:
  * The `active` and `paused` values in the `status` query parameter are deprecated and scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` query parameter instead.
  * The `active` attribute in the response is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.
  * The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab 17.0, this attribute returns an empty string in GitLab 17.0. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).


Example response:
json
```
[
    {
        "active": true,
        "paused": false,
        "description": "test-2-20150125",
        "id": 8,
        "ip_address": "",
        "is_shared": false,
        "runner_type": "project_type",
        "name": null,
        "online": false,
        "status": "offline"
    },
    {
        "active": true,
        "paused": false,
        "description": "development_runner",
        "id": 5,
        "ip_address": "",
        "is_shared": true,
        "runner_type": "instance_type",
        "name": null,
        "online": true,
        "status": "online"
    }
]
```

## Assign a runner to project[](https://docs.gitlab.com/api/runners/#assign-a-runner-to-project "Permalink")
Assign an available project runner to the project.
Prerequisites:
  * User access: You must have one of the following:
    * The Maintainer or Owner role for the project that owns the runner and the target project.
    * A custom role with the `admin_runners` permission in the relevant group or project.


```
POST /projects/:id/runners
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`runner_id` | integer | yes | The ID of a runner
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners" \
     --form "runner_id=9"
```

The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab 17.0, this attribute returns an empty string. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).
Example response:
json
```
{
    "active": true,
    "description": "test-2016-02-01",
    "id": 9,
    "ip_address": "",
    "is_shared": false,
    "runner_type": "project_type",
    "name": null,
    "online": true,
    "status": "online"
}
```

## Unassign a runner from project[](https://docs.gitlab.com/api/runners/#unassign-a-runner-from-project "Permalink")
Unassign a project runner from the project. You cannot unassign a runner from the owner project. If you attempt this action, an error occurs. Use the call to [delete a runner](https://docs.gitlab.com/api/runners/#delete-a-runner) instead.
Prerequisites:
  * You must not lock the runner, unless you are an administrator.
  * User access: You must have one of the following:
    * The Maintainer or Owner role in the project you want to unassign.
    * A custom role with the `admin_runners` permission in the relevant group or project.
  * An access token with the `manage_runner` scope and the appropriate role.


```
DELETE /projects/:id/runners/:runner_id
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`runner_id` | integer | yes | The ID of a runner
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners/9"
```

## List all of a group’s runners[](https://docs.gitlab.com/api/runners/#list-all-of-a-groups-runners "Permalink")
Lists all runners available in the group and its ancestor groups, including [any allowed instance runners](https://docs.gitlab.com/ci/runners/runners_scope/#enable-instance-runners-for-a-group).
Prerequisites:
  * User access: You must have one of the following:
    * Administrator access to the GitLab instance.
    * Owner or Auditor role in the group.
    * A custom role with the `admin_runners` permission in the group.
  * An access token with the `manage_runner` scope and the appropriate role.


```
GET /groups/:id/runners
GET /groups/:id/runners?type=group_type
GET /groups/:id/runners/all?status=online
GET /groups/:id/runners/all?paused=true
GET /groups/:id/runners?tag_list=tag1,tag2
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of the group
`type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type`. The `project_type` value is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/351466) and is scheduled for removal in GitLab 15.0
`status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, or `never_contacted`.
Other possible values are the deprecated `active` and `paused`.
Requesting `offline` runners might also return `stale` runners because `stale` is included in `offline`.
`paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs
`tag_list` | string array | no | A list of runner tags
`version_prefix` | string | no | The prefix of the version of the runners to return. For example, `15.0`, `14`, `16.1.241`
Deprecations:
  * The `active` and `paused` values in the `status` query parameter are deprecated and scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` query parameter instead.
  * The `active` attribute in the response is deprecated and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). Use the `paused` attribute instead.


shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/9/runners"
```

The `ip_address` attribute in the response is deprecated [in GitLab 16.1](https://gitlab.com/gitlab-org/gitlab/-/issues/415159) and is scheduled for removal in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). In GitLab, the attribute returns an empty string. The `ipAddress` attribute can be found inside the respective runner manager. It is only available through the GraphQL [`CiRunnerManager` type](https://docs.gitlab.com/api/graphql/reference/#cirunnermanager).
Example response:
json
```
[
  {
    "id": 3,
    "description": "Shared",
    "ip_address": "",
    "active": true,
    "paused": false,
    "is_shared": true,
    "runner_type": "instance_type",
    "name": "gitlab-runner",
    "online": null,
    "status": "never_contacted"
  },
  {
    "id": 6,
    "description": "Test",
    "ip_address": "",
    "active": true,
    "paused": false,
    "is_shared": true,
    "runner_type": "instance_type",
    "name": "gitlab-runner",
    "online": false,
    "status": "offline"
  },
  {
    "id": 8,
    "description": "Test 2",
    "ip_address": "",
    "active": true,
    "paused": false,
    "is_shared": false,
    "runner_type": "group_type",
    "name": "gitlab-runner",
    "online": null,
    "status": "never_contacted"
  }
]
```

## Create a runner[](https://docs.gitlab.com/api/runners/#create-a-runner "Permalink")
The endpoint uses registration tokens ([deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/380872)), which are disabled by default in GitLab 17.0 and later. Use [`POST /user/runners`](https://docs.gitlab.com/api/users/#create-a-runner-linked-to-a-user) instead to create runners with the recommended workflow.
Create a runner with a runner registration token.
This endpoint returns an `HTTP 410 Gone` status code if registration with runner registration tokens is disabled in the project or group settings. If registration with runner registration tokens is disabled, use the [`POST /user/runners`](https://docs.gitlab.com/api/users/#create-a-runner-linked-to-a-user) endpoint to create and register runners instead.
```
POST /runners
```

Attribute | Type | Required | Description
---|---|---|---
`token` | string | yes | [Registration token](https://docs.gitlab.com/api/runners/#registration-and-authentication-tokens)
`description` | string | no | Description of the runner
`info` | hash | no | Runner’s metadata. You can include `name`, `version`, `revision`, `platform`, and `architecture`, but only `version`, `platform`, and `architecture` are displayed in the **Admin** area of the UI
`active` | boolean | no | Deprecated: Use `paused` instead. Specifies if the runner is allowed to receive new jobs
`paused` | boolean | no | Specifies if the runner should ignore new jobs
`locked` | boolean | no | Specifies if the runner should be locked for the current project
`run_untagged` | boolean | no | Specifies if the runner should handle untagged jobs
`tag_list` | string array | no | A list of runner tags
`access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected`
`maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs
`maintainer_note` | string | no |  [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/350730), see `maintenance_note`
`maintenance_note` | string | no | Free-form maintenance notes for the runner (1024 characters)
shell
```
curl --request POST "https://gitlab.example.com/api/v4/runners" \
     --form "token=<registration_token>" --form "description=test-1-20150125-test" \
     --form "tag_list=ruby,mysql,tag1,tag2"
```

Response:
Status | Description
---|---
201 | Runner was created
403 | Invalid runner registration token
410 | Runner registration disabled
Example response:
json
```
{
    "id": 12345,
    "token": "6337ff461c94fd3fa32ba3b1ff4125",
    "token_expires_at": "2021-09-27T21:05:03.203Z"
}
```

## Delete a runner[](https://docs.gitlab.com/api/runners/#delete-a-runner "Permalink")
You can delete a runner by specifying the:
  * Runner ID
  * Runner’s authentication token


### Delete a runner by ID[](https://docs.gitlab.com/api/runners/#delete-a-runner-by-id "Permalink")
To delete the runner by ID, use your access token with the runner’s ID:
Prerequisites:
  * User access: You must have one of the following:
    * For instance runners: Administrator access to the GitLab instance.
    * For group runners: Owner role in the owner namespace.
    * For project runners: The Maintainer or Owner role in the project that owns the runner.
    * A custom role with the `admin_runners` permission in the relevant group or project.
  * An access token with the `manage_runner` scope and the appropriate role.


```
DELETE /runners/:id
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of a runner. The ID is visible in the UI under **Settings** > **CI/CD**. Expand **Runners** , and below **Remove Runner** is an ID preceded by the pound sign, for example, `#6`.
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6"
```

### Delete a runner by authentication token[](https://docs.gitlab.com/api/runners/#delete-a-runner-by-authentication-token "Permalink")
Delete the runner by using its authentication token.
```
DELETE /runners
```

Attribute | Type | Required | Description
---|---|---|---
`token` | string | yes | The runner’s [authentication token](https://docs.gitlab.com/api/runners/#registration-and-authentication-tokens).
shell
```
curl --request DELETE "https://gitlab.example.com/api/v4/runners" \
     --form "token=<authentication_token>"
```

Response:
Status | Description
---|---
204 | Runner was deleted
## Verify authentication for a registered runner[](https://docs.gitlab.com/api/runners/#verify-authentication-for-a-registered-runner "Permalink")
Validates authentication credentials for a registered runner.
```
POST /runners/verify
```

Attribute | Type | Required | Description
---|---|---|---
`token` | string | yes | The runner’s [authentication token](https://docs.gitlab.com/api/runners/#registration-and-authentication-tokens).
`system_id` | string | no | The runner’s system identifier. This attribute is required if the `token` starts with `glrt-`.
shell
```
curl --request POST "https://gitlab.example.com/api/v4/runners/verify" \
     --form "token=<authentication_token>"
```

Response:
Status | Description
---|---
200 | Credentials are valid
403 | Credentials are invalid
Example response:
json
```
{
    "id": 12345,
    "token": "glrt-6337ff461c94fd3fa32ba3b1ff4125",
    "token_expires_at": "2021-09-27T21:05:03.203Z"
}
```

## Reset instance’s runner registration token[](https://docs.gitlab.com/api/runners/#reset-instances-runner-registration-token "Permalink")
The option to pass runner registration tokens and support for certain configuration arguments is considered legacy and is not recommended. Use the [runner creation workflow](https://docs.gitlab.com/runner/register/#register-with-a-runner-authentication-token) to generate an authentication token to register runners. This process provides full traceability of runner ownership and enhances your runner fleet’s security.
For more information, see [Migrating to the new runner registration workflow](https://docs.gitlab.com/ci/runners/new_creation_workflow/).
Reset the runner registration token for the GitLab instance.
```
POST /runners/reset_registration_token
```

shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/runners/reset_registration_token"
```

## Reset project’s runner registration token[](https://docs.gitlab.com/api/runners/#reset-projects-runner-registration-token "Permalink")
The option to pass runner registration tokens and support for certain configuration arguments is considered legacy and is not recommended. Use the [runner creation workflow](https://docs.gitlab.com/runner/register/#register-with-a-runner-authentication-token) to generate an authentication token to register runners. This process provides full traceability of runner ownership and enhances your runner fleet’s security. For more information, see [Migrating to the new runner registration workflow](https://docs.gitlab.com/ci/runners/new_creation_workflow/).
Reset the runner registration token for a project.
```
POST /projects/:id/runners/reset_registration_token
```

shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/9/runners/reset_registration_token"
```

## Reset group’s runner registration token[](https://docs.gitlab.com/api/runners/#reset-groups-runner-registration-token "Permalink")
The option to pass runner registration tokens and support for certain configuration arguments is considered legacy and is not recommended. Use the [runner creation workflow](https://docs.gitlab.com/runner/register/#register-with-a-runner-authentication-token) to generate an authentication token to register runners. This process provides full traceability of runner ownership and enhances your runner fleet’s security. For more information, see [Migrating to the new runner registration workflow](https://docs.gitlab.com/ci/runners/new_creation_workflow/).
Reset the runner registration token for a group.
```
POST /groups/:id/runners/reset_registration_token
```

shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/9/runners/reset_registration_token"
```

## Reset runner’s authentication token by using the runner ID[](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-runner-id "Permalink")
Reset the runner’s authentication token by using its runner ID.
Prerequisites:
  * User access: You must have one of the following:
    * For instance runners: Administrator access to the GitLab instance.
    * For group runners: Owner role in the owner namespace.
    * For project runners: The Maintainer or Owner role in a project assigned to the runner.
    * A custom role with the `admin_runners` permission in the relevant group or project.
  * An access token with the `manage_runner` scope and the appropriate role.


```
POST /runners/:id/reset_authentication_token
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer | yes | The ID of a runner
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/runners/1/reset_authentication_token"
```

Example response:
json
```
{
    "token": "6337ff461c94fd3fa32ba3b1ff4125",
    "token_expires_at": "2021-09-27T21:05:03.203Z"
}
```

## Reset runner’s authentication token by using the current token[](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-current-token "Permalink")
Reset the runner’s authentication token by using the current token’s value as an input.
```
POST /runners/reset_authentication_token
```

Attribute | Type | Required | Description
---|---|---|---
`token` | string | yes | The authentication token of the runner
shell
```
curl --request POST --form "token=<current token>" \
     "https://gitlab.example.com/api/v4/runners/reset_authentication_token"
```

Example response:
json
```
{
    "token": "6337ff461c94fd3fa32ba3b1ff4125",
    "token_expires_at": "2021-09-27T21:05:03.203Z"
}
```

## Discover Job Router information[](https://docs.gitlab.com/api/runners/#discover-job-router-information "Permalink")
History
  * [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/19607) in GitLab 18.7 [with feature flags](https://docs.gitlab.com/administration/feature_flags/) named `job_router` and `job_router_instance_runners`. Disabled by default.


Get Job Router discovery information for a runner.
Prerequisites:
  * You must provide a valid runner authentication token.


```
GET /runners/router/discovery
```

shell
```
curl --header "Runner-Token: <runner_authentication_token>" \
     "https://gitlab.example.com/api/v4/runners/router/discovery"
```

Response:
The response contains the following fields:
Attribute | Type | Description
---|---|---
`server_url` | string | URL to the Job Router
The response returns with one of the following status codes:
Status | Description
---|---
`200` | Job Router information retrieved successfully
`403` | Forbidden
`501` | Job Router is not available
Example response:
json
```
{
    "server_url": "wss://kas.example.com"
}
```

Was this page helpful?YesNo
Edit this page
  *     * [ Open in Web IDE`.`Quickly and easily edit multiple files. ](https://gitlab.com/-/ide/project/gitlab-org/gitlab/edit/master/-/doc/api/runners.md)
    * [ View page sourceEdit this file only. ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/runners.md)
    * [ Create an issueSuggest improvements. ](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Documentation)


  * [Registration and authentication tokens](https://docs.gitlab.com/api/runners/#registration-and-authentication-tokens)
  * [List all available runners](https://docs.gitlab.com/api/runners/#list-all-available-runners)
  * [List all runners](https://docs.gitlab.com/api/runners/#list-all-runners)
  * [Retrieve runner’s details](https://docs.gitlab.com/api/runners/#retrieve-runners-details)
  * [Update runner’s details](https://docs.gitlab.com/api/runners/#update-runners-details)
  * [Pause a runner](https://docs.gitlab.com/api/runners/#pause-a-runner)
  * [List all jobs processed by a runner](https://docs.gitlab.com/api/runners/#list-all-jobs-processed-by-a-runner)
  * [List all runner’s managers](https://docs.gitlab.com/api/runners/#list-all-runners-managers)
  * [List all of a project’s runners](https://docs.gitlab.com/api/runners/#list-all-of-a-projects-runners)
  * [Assign a runner to project](https://docs.gitlab.com/api/runners/#assign-a-runner-to-project)
  * [Unassign a runner from project](https://docs.gitlab.com/api/runners/#unassign-a-runner-from-project)
  * [List all of a group’s runners](https://docs.gitlab.com/api/runners/#list-all-of-a-groups-runners)
  * [Create a runner](https://docs.gitlab.com/api/runners/#create-a-runner)
  * [Delete a runner](https://docs.gitlab.com/api/runners/#delete-a-runner)
  * [Delete a runner by ID](https://docs.gitlab.com/api/runners/#delete-a-runner-by-id)
  * [Delete a runner by authentication token](https://docs.gitlab.com/api/runners/#delete-a-runner-by-authentication-token)
  * [Verify authentication for a registered runner](https://docs.gitlab.com/api/runners/#verify-authentication-for-a-registered-runner)
  * [Reset instance’s runner registration token](https://docs.gitlab.com/api/runners/#reset-instances-runner-registration-token)
  * [Reset project’s runner registration token](https://docs.gitlab.com/api/runners/#reset-projects-runner-registration-token)
  * [Reset group’s runner registration token](https://docs.gitlab.com/api/runners/#reset-groups-runner-registration-token)
  * [Reset runner’s authentication token by using the runner ID](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-runner-id)
  * [Reset runner’s authentication token by using the current token](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-current-token)
  * [Discover Job Router information](https://docs.gitlab.com/api/runners/#discover-job-router-information)


[![GitLab Docs logo](https://docs.gitlab.com/gitlab-logo-footer.svg)](https://docs.gitlab.com/)
  * [Facebook](https://www.facebook.com/gitlab)
  * [LinkedIn](https://www.linkedin.com/company/gitlab-com)
  * [Twitter](https://twitter.com/gitlab)
  * [YouTube](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg)

[![Creative Commons License](https://docs.gitlab.com/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
Company
  * [About GitLab](https://about.gitlab.com/company/)
  * [View pricing](https://about.gitlab.com/pricing/)
  * [Try GitLab for free](https://about.gitlab.com/free-trial/)


Feedback
  * [View page source](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/runners.md)
  * [Edit in Web IDE](https://gitlab.com/-/ide/project/gitlab-org/gitlab/edit/master/-/doc/api/runners.md)
  * [Contribute to GitLab](https://about.gitlab.com/community/contribute/)
  * [Suggest updates](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Documentation)


Help & Community
  * [Get certified](https://university.gitlab.com/pages/certifications)
  * [Get support](https://about.gitlab.com/support/)
  * [Post on the GitLab forum](https://forum.gitlab.com/new-topic?title=topic%20title&body=topic%20body&tags=docs-feedback)


Resources
  * [Terms](https://about.gitlab.com/terms/)
  * [Privacy statement](https://about.gitlab.com/privacy/)
  * [Use of generative AI](https://docs.gitlab.com/legal/use_generative_ai/)
  * [Acceptable use of user licenses](https://docs.gitlab.com/legal/licensing_policy/)
  * Cookie Preferences


![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Fresource_state_events%2F&_biz_t=1772174455591&_biz_i=Resource%20state%20events%20API%20%7C%20GitLab%20Docs&_biz_n=156&rnd=754837&cdn_o=a&_biz_z=1772174455670)![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Frunners%2F&_biz_t=1772174455669&_biz_i=Runners%20API%20%7C%20GitLab%20Docs&_biz_n=157&rnd=198093&cdn_o=a&_biz_z=1772174455671)
![Company Logo](https://cdn.cookielaw.org/logos/aa14a5c8-79e3-442a-8177-464ad850b19d/e46c1d0d-1f66-481f-bc06-5427671431da/253e6fee-c4c0-4b60-bc35-79cdae5dda32/gitlab-logo-100.png)
## Privacy Preference Center
## Privacy Preference Center
  * ### Your Privacy
  * ### Strictly Necessary Cookies
  * ### Functionality Cookies
  * ### Performance and Analytics Cookies
  * ### Targeting and Advertising Cookies
  * ### Ad User Data
  * ### Ad Personalization


#### Your Privacy
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
[Cookie Policy](https://about.gitlab.com/privacy/cookies/)
**User ID:** 42fad8d5-ed56-4786-8d74-3c72635252d2
_This User ID will be used as a unique identifier while storing and accessing your preferences for future._
**Timestamp:** --
#### Strictly Necessary Cookies
Always Active
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, enabling you to securely log into the site, filling in forms, or using the customer checkout. GitLab processes any personal data collected through these cookies on the basis of our legitimate interest.
Cookies Details
#### Functionality Cookies
Functionality Cookies
These cookies enable helpful but non-essential website functions that improve your website experience. By recognizing you when you return to our website, they may, for example, allow us to personalize our content for you or remember your preferences. If you do not allow these cookies then some or all of these services may not function properly. GitLab processes any personal data collected through these cookies on the basis of your consent
Cookies Details
#### Performance and Analytics Cookies
Performance and Analytics Cookies
These cookies allow us and our third-party service providers to recognize and count the number of visitors on our websites and to see how visitors move around our websites when they are using it. This helps us improve our products and ensures that users can easily find what they need on our websites. These cookies usually generate aggregate statistics that are not associated with an individual. To the extent any personal data is collected through these cookies, GitLab processes that data on the basis of your consent.
Cookies Details
#### Targeting and Advertising Cookies
Targeting and Advertising Cookies
These cookies enable different advertising related functions. They may allow us to record information about your visit to our websites, such as pages visited, links followed, and videos viewed so we can make our websites and the advertising displayed on it more relevant to your interests. They may be set through our website by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant advertisements on other websites. GitLab processes any personal data collected through these cookies on the basis of your consent.
Cookies Details
#### Ad User Data
Ad User Data
Sets consent for sending user data to Google for advertising purposes.
Cookies Details
#### Ad Personalization
Ad Personalization
Sets consent for personalized advertising.
Cookies Details
Back Button
### Cookie List
Filter Button
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label
Clear
  * checkbox label label


Apply Cancel
Confirm My Choices
Allow All
[![Powered by Onetrust](https://cdn.cookielaw.org/logos/static/powered_by_logo.svg)](https://www.onetrust.com/products/cookie-consent/)
