GitLab Runner controller tokens API

openapi: 3.2.0
info:
  title: GitLab REST Runner controller tokens API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Runner controller tokens
  description: 'Use this API to create, list, rotate, and revoke the authentication tokens that runner controllers

    use to authenticate with a GitLab instance and manage runners.


    These endpoints require administrator access to the instance.


    > [!note]

    > The availability of these endpoints is controlled by a feature flag. They are available for

    > testing, but not ready for production use.'
  x-displayName: Runner controller tokens
  externalDocs:
    url: https://docs.gitlab.com/api/runner_controller_tokens/
paths:
  /api/v4/runner_controllers/{runner_controller_id}/tokens:
    post:
      operationId: postApiV4RunnerControllersRunnerControllerIdTokens
      summary: Create a runner controller token
      description: Creates a runner controller token.
      tags:
      - Runner controller tokens
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiRunnerControllerToken'
        '403':
          description: Forbidden
        '400':
          description: Bad Request
        '404':
          description: Not found
      parameters:
      - name: runner_controller_id
        required: true
        description: ID of the runner controller.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RunnerControllersRunnerControllerIdTokensRequest'
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: ultimate
  /api/v4/runner_controllers/{runner_controller_id}/tokens/{id}:
    get:
      operationId: getApiV4RunnerControllersRunnerControllerIdTokensId
      summary: Retrieve a single runner controller token
      description: Retrieves details of a specified runner controller token by its ID.
      tags:
      - Runner controller tokens
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiRunnerControllerToken'
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: runner_controller_id
        required: true
        description: ID of the runner controller.
        schema:
          type: integer
        in: path
      - name: id
        required: true
        description: ID of the runner controller token.
        schema:
          type: integer
        in: path
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: ultimate
    delete:
      operationId: deleteApiV4RunnerControllersRunnerControllerIdTokensId
      summary: Revoke a runner controller token
      description: Revokes an existing runner controller token.
      tags:
      - Runner controller tokens
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
        '400':
          description: Bad Request
        '404':
          description: Not found
      parameters:
      - name: runner_controller_id
        required: true
        description: ID of the runner controller.
        schema:
          type: integer
        in: path
      - name: id
        required: true
        description: ID of the runner controller token.
        schema:
          type: integer
        in: path
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: ultimate
  /api/v4/runner_controllers/{runner_controller_id}/tokens/{id}/rotate:
    post:
      operationId: postApiV4RunnerControllersRunnerControllerIdTokensIdRotate
      summary: Rotate a runner controller token
      description: Rotates an existing runner controller token.
      tags:
      - Runner controller tokens
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiRunnerControllerTokenWithToken'
        '403':
          description: Forbidden
        '400':
          description: Bad Request
        '404':
          description: Not found
      parameters:
      - name: runner_controller_id
        required: true
        description: ID of the runner controller.
        schema:
          type: integer
        in: path
      - name: id
        required: true
        description: ID of the runner controller token.
        schema:
          type: integer
        in: path
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: ultimate
components:
  schemas:
    APIEntitiesCiRunnerControllerTokenWithToken:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        runner_controller_id:
          type: integer
          format: int64
          example: 1
        description:
          type: string
          example: Controller for managing runner
        last_used_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        token:
          type: string
    postApiV4RunnerControllersRunnerControllerIdTokensRequest:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
          description: Description of the runner controller token.
          example: Token for managing runner
    APIEntitiesCiRunnerControllerToken:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        runner_controller_id:
          type: integer
          format: int64
          example: 1
        description:
          type: string
          example: Controller for managing runner
        last_used_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header