Skip to content

Create POST /api/v4/user/runners REST endpoint to create a runner and return an authentication token

Problem to solve

Customers rely on the current Runner REST API's and the registration token for automation that registers and associates Runners to an instance, group or project. The upcoming change to the use of an authentication token means we are implementing a GraphQL API to automate Runner creation. However, as several customers are using REST for their automation, we need to ensure a REST API is available.

Proposal

Develop a REST API for creating a Runner available to users with the :create_runner permission. The result is an authentication token. This API is the REST equivalent to the runnerCreate GraphQL mutation.

Release notes

Users can automate creating a runner associated with a user. This REST API endpoint supports the Next GitLab Runner Token Architecture workflow. Available attributes include:

  • runner_type
  • namespace_id
  • description
  • paused
  • locked
  • run_untagged
  • tag_list
  • access_level
  • maximum_timeout
  • maintenance_note

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

Edited by Darren Eastman