GitLab Unleash API

openapi: 3.2.0
info:
  title: GitLab REST Unleash 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: Unleash
  description: 'Use this API to serve feature flags to an

    Unleash-compatible client, and to register that client and receive its metrics. Generally these

    endpoints are used by an Unleash client and are not meant for manual consumption.'
  x-displayName: Unleash
paths:
  /api/v4/feature_flags/unleash/{project_id}:
    get:
      operationId: getApiV4FeatureFlagsUnleashProjectId
      summary: Get Unleash features
      description: This endpoint is a no-op and always returns a 200 OK response.
      tags:
      - Unleash
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: project_id
        required: true
        description: ID of the project.
        schema:
          type: string
        in: path
      - name: instance_id
        required: false
        description: Instance ID of Unleash Client.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: app_name
        required: false
        description: Application name of Unleash Client.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/feature_flags/unleash/{project_id}/features:
    get:
      operationId: getApiV4FeatureFlagsUnleashProjectIdFeatures
      summary: Get a list of features (v2 client support)
      description: Deprecated in GitLab 15.6
      tags:
      - Unleash
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
        '400':
          description: Bad Request
      deprecated: true
      parameters:
      - name: project_id
        required: true
        description: ID of the project.
        schema:
          type: string
        in: path
      - name: instance_id
        required: false
        description: Instance ID of Unleash Client.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: app_name
        required: false
        description: Application name of Unleash Client.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/feature_flags/unleash/{project_id}/client/features:
    get:
      operationId: getApiV4FeatureFlagsUnleashProjectIdClientFeatures
      summary: Get a list of features
      description: Returns feature flags in the Unleash client features format used by GitLab feature flag clients.
      tags:
      - Unleash
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: project_id
        required: true
        description: ID of the project.
        schema:
          type: string
        in: path
      - name: instance_id
        required: false
        description: Instance ID of Unleash Client.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: app_name
        required: false
        description: Application name of Unleash Client.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/feature_flags/unleash/{project_id}/client/register:
    post:
      operationId: postApiV4FeatureFlagsUnleashProjectIdClientRegister
      summary: Register Unleash client
      description: This endpoint is a no-op and always returns a 200 OK response.
      tags:
      - Unleash
      responses:
        '201':
          description: Created
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: project_id
        required: true
        description: ID of the project.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4FeatureFlagsUnleashProjectIdClientRegisterRequest'
  /api/v4/feature_flags/unleash/{project_id}/client/metrics:
    post:
      operationId: postApiV4FeatureFlagsUnleashProjectIdClientMetrics
      summary: Report Unleash client metrics
      description: This endpoint is a no-op and always returns a 200 OK response.
      tags:
      - Unleash
      responses:
        '201':
          description: Created
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: project_id
        required: true
        description: ID of the project.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4FeatureFlagsUnleashProjectIdClientMetricsRequest'
components:
  schemas:
    postApiV4FeatureFlagsUnleashProjectIdClientMetricsRequest:
      type: object
      properties:
        instance_id:
          type:
          - string
          - 'null'
          description: Instance ID of Unleash Client.
        app_name:
          type:
          - string
          - 'null'
          description: Application name of Unleash Client.
    postApiV4FeatureFlagsUnleashProjectIdClientRegisterRequest:
      type: object
      properties:
        instance_id:
          type:
          - string
          - 'null'
          description: Instance ID of Unleash Client.
        app_name:
          type:
          - string
          - 'null'
          description: Application name of Unleash Client.
  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