Skip to content

Deprecation - Support for registration tokens and server-side runner configuration in POST /api/v4/runners endpoint

For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features

Deprecation Summary

The support for registration tokens and certain runner configuration arguments in the POST method on the /api/v4/runners endpoint is deprecated.

This endpoint registers a Runner with a GitLab instance at the instance, group, or project level through the API. We plan to remove the support for registration tokens and certain configuration arguments in this endpoint in GitLab 16.0.

Suppose you have developed and relied on automation for registering runners using this endpoint. In that case, you will need to adopt the new Runner registration method, as the current automation that you have developed will stop functioning with the changes to the endpoint in GitLab 16.0. Namely, calls to the endpoint that include a runner registration token or certain arguments such as locked, run_untagged, or tag_list will return an HTTP 410 Gone status code.

Documentation

Breaking Change

  • Yes

Affected Customers

Who is affected by this deprecation: GitLab.com users, Self-managed users, or Dedicated users? (choose all that apply)

  • GitLab.com
  • Self-Managed
  • Dedicated

Affected Tier

What pricing tiers are impacted?

  • GitLab Free
  • GitLab Premium
  • GitLab Ultimate

Checklists

Labels

  • This issue is labeled deprecation, and with the relevant ~devops::, ~group::, and ~Category: labels.
  • This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.

Timeline

Please add links to the relevant merge requests.

  • As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: 14.8, 14.9, 14.10, 15.0 – 14.8 is the third milestone preceding the major release):
  • On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post.
  • On the major milestone:

Mentions

  • Your stage's stable counterparts have been @mentioned on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.
    • To see who the stable counterparts are for a product team visit product categories
      • If there is no stable counterpart listed for Sales/CS please mention @timtams
      • If there is no stable counterpart listed for Support please mention @gitlab-com/support/managers
      • If there is no stable counterpart listed for Marketing please mention @cfoster3
  • Your GPM has been @mentioned so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.

Deprecation Milestone

15.6

Planned Removal Milestone

The feature / functionality will be removed in milestone: 18.0

Links

Next GitLab Runner Token Architecture

Communication plan

Customer impact

  • All users at the instance, group, or project levels that have automation workflows that still rely on registration tokens for creating new runners will find that these workflows no longer work with GitLab 18.0.
  • Customers must insert the `authentication
  • See the Next GitLab Runner Token Architecture handbook page for the details.
Edited by Darren Eastman