GitLab Features API

openapi: 3.2.0
info:
  title: GitLab REST Features 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: Features
  description: 'Use this API to manage the Flipper-based feature flags used in the development of GitLab itself.


    These endpoints support only boolean and percentage-of-time gate values, and require administrator

    authorization.'
  x-displayName: Features
  externalDocs:
    url: https://docs.gitlab.com/api/features/
paths:
  /api/v4/features:
    get:
      operationId: getApiV4Features
      summary: List all feature flags
      description: Lists all feature flags for the instance.
      tags:
      - Features
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesFeature'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/features/definitions:
    get:
      operationId: getApiV4FeaturesDefinitions
      summary: List all feature flag definitions
      description: Lists all feature flag definitions.
      tags:
      - Features
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesFeatureDefinition'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/features/{name}:
    post:
      operationId: postApiV4FeaturesName
      summary: Create or update a feature flag
      description: Creates or updates a feature flag value. If a feature with the given name doesn't exist yet, the operation creates one. The value can be a boolean or an integer to indicate percentage of time.
      tags:
      - Features
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeature'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: name
        required: true
        description: Name of the feature flag.
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4FeaturesNameRequest'
    delete:
      operationId: deleteApiV4FeaturesName
      summary: Delete a feature
      description: Deletes a feature gate. Returns the same response if the feature gate does not exist.
      tags:
      - Features
      responses:
        '204':
          description: Resource deleted
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Name of the feature flag.
        schema:
          type: string
        in: path
components:
  schemas:
    APIEntitiesFeatureDefinition:
      type: object
      properties:
        name:
          type: string
        feature_issue_url:
          type: string
        introduced_by_url:
          type: string
        rollout_issue_url:
          type: string
        milestone:
          type: string
        log_state_changes:
          type: boolean
        type:
          type: string
        group:
          type: string
        default_enabled:
          type: boolean
        intended_to_rollout_by:
          type: string
    APIEntitiesFeature:
      type: object
      properties:
        name:
          type: string
          example: experimental_feature
        state:
          type: string
          example: 'off'
        gates:
          $ref: '#/components/schemas/APIEntitiesFeatureGate'
        definition:
          $ref: '#/components/schemas/APIEntitiesFeatureDefinition'
    APIEntitiesFeatureGate:
      type: object
      properties:
        key:
          type: string
          example: percentage_of_actors
        value:
          type: integer
          example: 34
    postApiV4FeaturesNameRequest:
      type: object
      properties:
        value:
          oneOf:
          - type:
            - string
            - 'null'
          - type:
            - integer
            - 'null'
          description: Value to set for the feature flag. Use `true` or `false` to enable or disable it, or an integer for the percentage of time it should be enabled.
        key:
          type:
          - string
          - 'null'
          enum:
          - percentage_of_actors
          - percentage_of_time
          - null
          description: Rollout strategy for a percentage `value`. Omit it to apply the percentage to time. Mutually exclusive with `feature_group`, `user`, `group`, `namespace`, `project`, `organization`, `repository`, `runner`, `endpoint`.
        feature_group:
          type:
          - string
          - 'null'
          description: Name of the feature group. Mutually exclusive with `key`.
        user:
          type:
          - string
          - 'null'
          description: GitLab username or a comma-separated list of usernames. Mutually exclusive with `key`.
        group:
          type:
          - string
          - 'null'
          description: GitLab group path, for example `gitlab-org`, or a comma-separated list of group paths. Mutually exclusive with `key`.
        namespace:
          type:
          - string
          - 'null'
          description: GitLab group or user namespace path, for example `john-doe`, or a comma-separated list of namespace paths. Introduced in GitLab 15.0. Mutually exclusive with `key`.
        project:
          type:
          - string
          - 'null'
          description: Project path, for example `gitlab-org/gitlab-foss`, or a comma-separated list of project paths. Mutually exclusive with `key`.
        organization:
          type:
          - string
          - 'null'
          description: Organization ID or path, for example `1` or `default`, or a comma-separated list of organization IDs or paths. Mutually exclusive with `key`.
        repository:
          type:
          - string
          - 'null'
          description: Repository path, for example `gitlab-org/gitlab-test.git`, `gitlab-org/gitlab-test.wiki.git`, or `snippets/21.git`. Use commas to separate multiple repository paths. Mutually exclusive with `key`.
        runner:
          type:
          - string
          - 'null'
          description: Runner ID or a comma-separated list of runner IDs. Mutually exclusive with `key`.
        endpoint:
          type:
          - string
          - 'null'
          description: Caller ID identifying a code path, for example `GET /api/v4/projects/:id` or `ProjectsController#show`. Use a comma to separate multiple endpoint paths. Mutually exclusive with `key`.
        force:
          type:
          - boolean
          - 'null'
          description: If `true`, skips feature flag validation checks, such as a YAML definition.
      required:
      - value
  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