GitLab CI/CD ci_runners API

Operations about ci_runners

Documentation GitHub OpenAPI

Operations 6

POST /api/v4/runners Register a new runner #

DELETE /api/v4/runners Delete a runner by authentication token #

DELETE /api/v4/runners/managers Internal endpoint that deletes a runner manager by authentication token and system ID. #

POST /api/v4/runners/verify Verify authentication for a registered runner #

POST /api/v4/runners/reset_authentication_token #

GET /api/v4/runners/router/discovery Discover Job Router information #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/gitlab-ci-ci-runners-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: GitLab access_requests Ci Runners API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: ci_runners
  description: Operations about ci_runners
paths:
  /api/v4/runners:
    post:
      summary: Register a new runner
      description: Register a new runner for the instance
      responses:
        '201':
          description: Register a new runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Ci_RunnerRegistrationDetails'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '410':
          description: Gone
      tags:
      - ci_runners
      operationId: postApiV4Runners
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4Runners'
        required: true
    delete:
      summary: Delete a runner by authentication token
      description: Delete a registered runner
      parameters:
      - in: query
        name: token
        description: The runner's authentication token
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Delete a registered runner
        '403':
          description: Forbidden
      tags:
      - ci_runners
      operationId: deleteApiV4Runners
  /api/v4/runners/managers:
    delete:
      summary: Internal endpoint that deletes a runner manager by authentication token and system ID.
      description: Delete a registered runner manager
      parameters:
      - in: query
        name: token
        description: The runner's authentication token
        required: true
        schema:
          type: string
      - in: query
        name: system_id
        description: The runner's system identifier.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Runner manager was deleted
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
      tags:
      - ci_runners
      operationId: deleteApiV4RunnersManagers
  /api/v4/runners/verify:
    post:
      summary: Verify authentication for a registered runner
      description: Validate authentication credentials
      responses:
        '200':
          description: Credentials are valid
        '403':
          description: Forbidden
        '422':
          description: Runner is orphaned
      tags:
      - ci_runners
      operationId: postApiV4RunnersVerify
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RunnersVerify'
        required: true
  /api/v4/runners/reset_authentication_token:
    post:
      description: Reset runner authentication token with current token
      responses:
        '201':
          description: Reset runner authentication token with current token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Ci_ResetTokenResult'
        '403':
          description: Forbidden
        '422':
          description: Unprocessable Entity
      tags:
      - ci_runners
      operationId: postApiV4RunnersResetAuthenticationToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4RunnersResetAuthenticationToken'
        required: true
  /api/v4/runners/router/discovery:
    get:
      summary: Discover Job Router information
      description: This endpoint can be used by the runner to retrieve information about the Job Router.
      responses:
        '200':
          description: Discover Job Router information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Ci_JobRouter_DiscoveryInformation'
        '403':
          description: 403 Forbidden
        '501':
          description: 501 Not Implemented
      tags:
      - ci_runners
      operationId: getApiV4RunnersRouterDiscovery
components:
  schemas:
    API_Entities_Ci_RunnerRegistrationDetails:
      type: object
      properties:
        id:
          type: string
        token:
          type: string
        token_expires_at:
          type: string
      required:
      - id
      - token
      - token_expires_at
      description: API_Entities_Ci_RunnerRegistrationDetails model
    postApiV4Runners:
      type: object
      properties:
        token:
          type: string
          description: Registration token
        description:
          type: string
          description: Description of the runner
        maintainer_note:
          type: string
          description: 'Deprecated: see `maintenance_note`'
        maintenance_note:
          type: string
          description: Free-form maintenance notes for the runner (1024 characters)
        info:
          type: object
          description: Runner's metadata
          properties:
            name:
              type: string
              description: Runner's name
            version:
              type: string
              description: Runner's version
            revision:
              type: string
              description: Runner's revision
            platform:
              type: string
              description: Runner's platform
            architecture:
              type: string
              description: Runner's architecture
        active:
          type: boolean
          description: 'Deprecated: Use `paused` instead. Specifies if the runner is allowed to receive new jobs'
        paused:
          type: boolean
          description: Specifies if the runner should ignore new jobs
        locked:
          type: boolean
          description: Specifies if the runner should be locked for the current project
        access_level:
          type: string
          description: The access level of the runner
          enum:
          - not_protected
          - ref_protected
        run_untagged:
          type: boolean
          description: Specifies if the runner should handle untagged jobs
        tag_list:
          type: array
          description: A list of runner tags
          items:
            type: string
        maximum_timeout:
          type: integer
          format: int32
          description: Maximum timeout that limits the amount of time (in seconds) that runners can run jobs
      required:
      - token
      description: Register a new runner
    postApiV4RunnersResetAuthenticationToken:
      type: object
      properties:
        token:
          type: string
          description: The current authentication token of the runner
      required:
      - token
      description: Reset runner authentication token with current token
    API_Entities_Ci_ResetTokenResult:
      type: object
      properties:
        token:
          type: string
        token_expires_at:
          type: string
      required:
      - token
      description: API_Entities_Ci_ResetTokenResult model
    postApiV4RunnersVerify:
      type: object
      properties:
        token:
          type: string
          description: The runner's authentication token
        system_id:
          type: string
          description: The runner's system identifier
      required:
      - token
      description: Validate authentication credentials
    API_Entities_Ci_JobRouter_DiscoveryInformation:
      type: object
      properties:
        server_url:
          type: string
          example: wss://kas.example.com
      required:
      - server_url
      description: API_Entities_Ci_JobRouter_DiscoveryInformation model
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query