GitLab CI runners API

openapi: 3.2.0
info:
  title: GitLab REST CI runners 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: CI runners
  description: '> [!warning]

    > Registering a runner with a registration token is

    > deprecated and disabled by default in

    > GitLab 17.0 and later.


    Use this API to register a runner with an instance, verify its

    authentication, reset its authentication token, and unregister it. GitLab Runner uses these endpoints

    itself.


    To create a runner, or to manage runners that already exist, use the Runners endpoints.'
  x-displayName: CI runners
  externalDocs:
    url: https://docs.gitlab.com/api/runners/
paths:
  /api/v4/runners:
    post:
      operationId: postApiV4Runners
      summary: Create a runner
      description: Creates a runner.
      tags:
      - CI runners
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiRunnerRegistrationDetails'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '410':
          description: Gone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RunnersRequest'
    delete:
      operationId: deleteApiV4Runners
      summary: Delete a registered runner
      description: Deletes a specified registered runner.
      tags:
      - CI runners
      responses:
        '204':
          description: Resource deleted
        '403':
          description: Forbidden
        '400':
          description: Bad Request
      parameters:
      - name: token
        required: true
        description: Authentication token of the runner.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/runners/managers:
    delete:
      operationId: deleteApiV4RunnersManagers
      summary: Delete a registered runner manager
      description: Deletes a runner manager identified by the runner authentication token and system ID.
      tags:
      - CI runners
      responses:
        '204':
          description: Runner manager was deleted
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: token
        required: true
        description: Authentication token of the runner.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: system_id
        required: true
        description: System identifier of the runner.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/runners/verify:
    post:
      operationId: postApiV4RunnersVerify
      summary: Verify authentication for a registered runner
      description: Verifies authentication for a registered runner.
      tags:
      - CI runners
      responses:
        '200':
          description: Credentials are valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiRunnerRegistrationDetails'
        '403':
          description: Forbidden
        '422':
          description: Runner is orphaned
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RunnersVerifyRequest'
  /api/v4/runners/reset_authentication_token:
    post:
      operationId: postApiV4RunnersResetAuthenticationToken
      summary: Reset a runner authentication token with the current token
      description: Resets a runner authentication token with the token used to authenticate the request.
      tags:
      - CI runners
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiResetTokenResult'
        '403':
          description: Forbidden
        '422':
          description: Unprocessable Entity
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RunnersResetAuthenticationTokenRequest'
  /api/v4/runners/router/discovery:
    get:
      operationId: getApiV4RunnersRouterDiscovery
      summary: Discover Job Router information
      description: Discovers Job Router information for a runner. You must provide a valid runner authentication token.
      tags:
      - CI runners
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiJobRouterDiscoveryInformation'
        '403':
          description: 403 Forbidden
        '501':
          description: 501 Not Implemented
components:
  schemas:
    postApiV4RunnersRequest:
      type: object
      properties:
        token:
          type:
          - string
          - 'null'
          description: Registration token.
        description:
          type:
          - string
          - 'null'
          description: Description of the runner.
        maintainer_note:
          type:
          - string
          - 'null'
          description: Free-form maintenance notes for the runner. Deprecated. Use `maintenance_note` instead. Mutually exclusive with `maintenance_note`.
        maintenance_note:
          type:
          - string
          - 'null'
          description: Free-form maintenance notes for the runner (1024 characters). Mutually exclusive with `maintainer_note`.
        info:
          type:
          - object
          - 'null'
          description: Runner's metadata
          properties:
            name:
              type:
              - string
              - 'null'
              description: Runner's name
            version:
              type:
              - string
              - 'null'
              description: Runner's version
            revision:
              type:
              - string
              - 'null'
              description: Runner's revision
            platform:
              type:
              - string
              - 'null'
              description: Runner's platform
            architecture:
              type:
              - string
              - 'null'
              description: Runner's architecture
        active:
          type:
          - boolean
          - 'null'
          description: If `true`, the runner is allowed to receive new jobs. Deprecated. Use `paused` instead. Mutually exclusive with `paused`.
        paused:
          type:
          - boolean
          - 'null'
          description: If `true`, the runner ignores new jobs. Mutually exclusive with `active`.
        locked:
          type:
          - boolean
          - 'null'
          description: If `true`, the runner is locked for the current project.
        access_level:
          type:
          - string
          - 'null'
          enum:
          - not_protected
          - ref_protected
          - null
          description: Access level of the runner.
        run_untagged:
          type:
          - boolean
          - 'null'
          description: If `true`, the runner handles untagged jobs.
        tag_list:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of runner tags.
        maximum_timeout:
          type:
          - integer
          - 'null'
          description: Maximum time, in seconds, that runners can spend running a job.
      required:
      - token
    APIEntitiesCiRunnerRegistrationDetails:
      type: object
      properties:
        id:
          type: string
        token:
          type: string
        token_expires_at:
          type: string
    APIEntitiesCiJobRouterDiscoveryInformation:
      type: object
      properties:
        server_url:
          type: string
          example: wss://kas.example.com
    postApiV4RunnersResetAuthenticationTokenRequest:
      type: object
      properties:
        token:
          type:
          - string
          - 'null'
          description: Authentication token of the runner.
      required:
      - token
    postApiV4RunnersVerifyRequest:
      type: object
      properties:
        token:
          type:
          - string
          - 'null'
          description: Authentication token of the runner.
        system_id:
          type:
          - string
          - 'null'
          description: System identifier of the runner. Must be provided if `token` starts with `glrt-`.
      required:
      - token
    APIEntitiesCiResetTokenResult:
      type: object
      properties:
        token:
          type: string
        token_expires_at:
          type: string
  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