GitLab Feature flags API

openapi: 3.2.0
info:
  title: GitLab REST Feature flags 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: Feature Flags
  description: 'Use this API to manage a project''s feature flags

    and the user lists that scope them to

    particular users.


    These endpoints require the Developer, Maintainer, or Owner role.'
  x-displayName: Feature flags
  externalDocs:
    url: https://docs.gitlab.com/api/feature_flag_user_lists/
paths:
  /api/v4/projects/{id}/feature_flags_user_lists:
    get:
      operationId: getApiV4ProjectsIdFeatureFlagsUserLists
      summary: List all feature flag user lists for a project
      description: Lists all feature flag user lists for a specified project.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesFeatureFlagUserList'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: search
        required: false
        description: Return user lists matching the search criteria.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdFeatureFlagsUserLists
      summary: Create a feature flag user list
      description: Creates a feature flag user list in a specified project.
      tags:
      - Feature Flags
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlagUserList'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdFeatureFlagsUserListsRequest'
  /api/v4/projects/{id}/feature_flags_user_lists/{iid}:
    get:
      operationId: getApiV4ProjectsIdFeatureFlagsUserListsIid
      summary: Retrieve a feature flag user list
      description: Retrieves a specified feature flag user list.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlagUserList'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: iid
        required: true
        description: Internal ID of the project's feature flag user list.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
    put:
      operationId: putApiV4ProjectsIdFeatureFlagsUserListsIid
      summary: Update a feature flag user list
      description: Updates a specified feature flag user list.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlagUserList'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: iid
        required: true
        description: Internal ID of the project's feature flag user list.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdFeatureFlagsUserListsIidRequest'
    delete:
      operationId: deleteApiV4ProjectsIdFeatureFlagsUserListsIid
      summary: Delete feature flag user list
      description: Deletes a specified feature flag user list.
      tags:
      - Feature Flags
      responses:
        '204':
          description: Resource deleted
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '409':
          description: Conflict
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: iid
        required: true
        description: Internal ID of the project's feature flag user list.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
  /api/v4/projects/{id}/feature_flags:
    get:
      operationId: getApiV4ProjectsIdFeatureFlags
      summary: List all feature flags for a project
      description: Lists all feature flags of the requested project. Use the `page` and `per_page` pagination parameters to control the pagination of results.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesFeatureFlag'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: scope
        required: false
        description: Filter feature flags by condition.
        schema:
          type:
          - string
          - 'null'
          enum:
          - enabled
          - disabled
          - null
        in: query
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdFeatureFlags
      summary: Create a feature flag
      description: Creates a feature flag for a specified project.
      tags:
      - Feature Flags
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlag'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdFeatureFlagsRequest'
  /api/v4/projects/{id}/feature_flags_settings:
    get:
      operationId: getApiV4ProjectsIdFeatureFlagsSettings
      summary: Retrieve feature flag settings
      description: Retrieves the feature flag settings of a specified project.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlagSettings'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
    put:
      operationId: putApiV4ProjectsIdFeatureFlagsSettings
      summary: Update feature flag settings
      description: Updates the feature flag settings of a specified project.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlagSettings'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdFeatureFlagsSettingsRequest'
  /api/v4/projects/{id}/feature_flags/{feature_flag_name}:
    get:
      operationId: getApiV4ProjectsIdFeatureFlagsFeatureFlagName
      summary: Retrieve a feature flag
      description: Retrieves a specified feature flag.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlag'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: feature_flag_name
        required: true
        description: Name of the feature flag.
        schema:
          type: string
        in: path
    put:
      operationId: putApiV4ProjectsIdFeatureFlagsFeatureFlagName
      summary: Update a feature flag
      description: Updates a specified feature flag.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlag'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: feature_flag_name
        required: true
        description: Name of the feature flag.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdFeatureFlagsFeatureFlagNameRequest'
    delete:
      operationId: deleteApiV4ProjectsIdFeatureFlagsFeatureFlagName
      summary: Delete a feature flag
      description: Deletes a specified feature flag.
      tags:
      - Feature Flags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesFeatureFlag'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: feature_flag_name
        required: true
        description: Name of the feature flag.
        schema:
          type: string
        in: path
components:
  schemas:
    postApiV4ProjectsIdFeatureFlagsRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the feature flag.
        description:
          type:
          - string
          - 'null'
          description: Description of the feature flag.
        active:
          type: boolean
          description: If `true`, the feature flag is active.
          default: true
        strategies:
          type:
          - array
          - 'null'
          description: Array of feature flag [strategies](https://docs.gitlab.com/operations/feature_flags/#feature-flag-strategies).
          items:
            type: object
            properties:
              name:
                type:
                - string
                - 'null'
                description: Name of the strategy. Can be `default`, `gradualRolloutUserId`, `userWithId`, `gitlabUserList`, or `flexibleRollout`.
              parameters:
                type:
                - object
                - 'null'
                description: Strategy parameters as a JSON-formatted string, for example `{"userIds":"user1"}`.
              user_list_id:
                type:
                - integer
                - 'null'
                description: ID of the feature flag user list. Applies only if the strategy is `gitlabUserList`.
              scopes:
                type:
                - array
                - 'null'
                description: Array of scopes for the strategy.
                items:
                  type: object
                  properties:
                    environment_scope:
                      type:
                      - string
                      - 'null'
                      description: Environment scope of the scope.
                  required:
                  - environment_scope
            required:
            - name
      required:
      - name
    putApiV4ProjectsIdFeatureFlagsSettingsRequest:
      type: object
      properties:
        minimum_role:
          type: string
          enum:
          - no_one_allowed
          - developer
          - maintainer
          - owner
          description: Minimum role required to create, update, toggle, and delete feature flags
          minLength: 1
      required:
      - minimum_role
    putApiV4ProjectsIdFeatureFlagsFeatureFlagNameRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: New name of the feature flag.
        description:
          type:
          - string
          - 'null'
          description: Description of the feature flag.
        active:
          type:
          - boolean
          - 'null'
          description: If `true`, the feature flag is active.
        strategies:
          type:
          - array
          - 'null'
          description: Array of feature flag [strategies](https://docs.gitlab.com/operations/feature_flags/#feature-flag-strategies).
          items:
            type: object
            properties:
              id:
                type:
                - integer
                - 'null'
                description: ID of the feature flag strategy.
              name:
                type:
                - string
                - 'null'
                description: Name of the strategy.
              parameters:
                type:
                - object
                - 'null'
                description: Strategy parameters as a JSON-formatted string, for example `{"userIds":"user1"}`.
              user_list_id:
                type:
                - integer
                - 'null'
                description: ID of the feature flag user list. Applies only if the strategy is `gitlabUserList`.
              _destroy:
                type:
                - boolean
                - 'null'
                description: If `true`, deletes the strategy.
              scopes:
                type:
                - array
                - 'null'
                description: Array of scopes for the strategy.
                items:
                  type: object
                  properties:
                    id:
                      type:
                      - integer
                      - 'null'
                      description: ID of the scope.
                    environment_scope:
                      type:
                      - string
                      - 'null'
                      description: Environment scope of the scope.
                    _destroy:
                      type:
                      - boolean
                      - 'null'
                      description: If `true`, deletes the scope.
    APIEntitiesFeatureFlagUserList:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 1
        name:
          type: string
          example: user_list
        user_xids:
          type: string
          example: user1,user2
        project_id:
          type: integer
          format: int64
          example: 2
        created_at:
          type: string
          format: date-time
          example: '2020-02-04T08:13:10.507Z'
        updated_at:
          type: string
          format: date-time
          example: '2020-02-04T08:13:10.507Z'
        path:
          type: string
        edit_path:
          type: string
    APIEntitiesFeatureFlag:
      type: object
      properties:
        name:
          type: string
          example: merge_train
        description:
          type: string
          example: merge train feature flag
        active:
          type: boolean
        version:
          type: string
          example: new_version_flag
        created_at:
          type: string
          format: date-time
          example: '2019-11-04T08:13:51.423Z'
        updated_at:
          type: string
          format: date-time
          example: '2019-11-04T08:13:51.423Z'
        scopes:
          type: array
        strategies:
          $ref: '#/components/schemas/APIEntitiesFeatureFlagStrategy'
    APIEntitiesFeatureFlagStrategy:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: userWithId
        parameters:
          type: string
          example: '{"userIds": "user1"}'
        scopes:
          $ref: '#/components/schemas/APIEntitiesFeatureFlagScope'
        user_list:
          $ref: '#/components/schemas/APIEntitiesFeatureFlagBasicUserList'
    APIEntitiesFeatureFlagBasicUserList:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 1
        name:
          type: string
          example: user_list
        user_xids:
          type: string
          example: user1,user2
    postApiV4ProjectsIdFeatureFlagsUserListsRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the list.
        user_xids:
          type:
          - string
          - 'null'
          description: Comma-separated list of external user IDs.
      required:
      - name
      - user_xids
    putApiV4ProjectsIdFeatureFlagsUserListsIidRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the list.
        user_xids:
          type:
          - string
          - 'null'
          description: Comma-separated list of external user IDs.
    APIEntitiesFeatureFlagSettings:
      type: object
      properties:
        minimum_role:
          type: string
          example: developer
    APIEntitiesFeatureFlagScope:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        environment_scope:
          type: string
          example: production
  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