Red Hat Ansible Automation Platform Feature Flags API

openapi: 3.2.0
info:
  title: Red Hat Ansible Automation Platform Feature Flags API
  version: '1.0'
  description: 'Operations tagged feature_flags across 3 of this provider''s published API definitions: red-hat-ansible-automation-platform-automation-controller-openapi.json, red-hat-ansible-automation-platform-event-driven-ansible-openapi.json, red-hat-ansible-automation-platform-platform-gateway-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/eda/v1
tags:
- name: Feature Flags
paths:
  /api/v2/feature_flags/states/:
    get:
      operationId: feature_flags_states_list
      description: 'A view class for displaying feature flags states.

        To add/update/remove a feature flag, see the instructions in

        `docs/apps/feature_flags.md`'
      parameters:
      - in: query
        name: condition
        schema:
          type: string
        description: Filter by condition (exact match)
      - in: query
        name: condition__icontains
        schema:
          type: string
        description: Filter by condition (case-insensitive partial match)
      - in: query
        name: created
        schema:
          type: string
        description: Filter by created (exact match)
      - in: query
        name: created__gt
        schema:
          type: string
        description: Filter by created (gt)
      - in: query
        name: created__gte
        schema:
          type: string
        description: Filter by created (gte)
      - in: query
        name: created__lt
        schema:
          type: string
        description: Filter by created (lt)
      - in: query
        name: created__lte
        schema:
          type: string
        description: Filter by created (lte)
      - in: query
        name: created_by
        schema:
          type: string
        description: Filter by created_by (exact match)
      - in: query
        name: description
        schema:
          type: string
        description: Filter by description (exact match)
      - in: query
        name: description__icontains
        schema:
          type: string
        description: Filter by description (case-insensitive partial match)
      - in: query
        name: id
        schema:
          type: string
        description: Filter by id (exact match)
      - in: query
        name: id__gt
        schema:
          type: string
        description: Filter by id (gt)
      - in: query
        name: id__gte
        schema:
          type: string
        description: Filter by id (gte)
      - in: query
        name: id__lt
        schema:
          type: string
        description: Filter by id (lt)
      - in: query
        name: id__lte
        schema:
          type: string
        description: Filter by id (lte)
      - in: query
        name: labels
        schema:
          type: string
        description: Filter by labels (exact match)
      - in: query
        name: modified
        schema:
          type: string
        description: Filter by modified (exact match)
      - in: query
        name: modified__gt
        schema:
          type: string
        description: Filter by modified (gt)
      - in: query
        name: modified__gte
        schema:
          type: string
        description: Filter by modified (gte)
      - in: query
        name: modified__lt
        schema:
          type: string
        description: Filter by modified (lt)
      - in: query
        name: modified__lte
        schema:
          type: string
        description: Filter by modified (lte)
      - in: query
        name: modified_by
        schema:
          type: string
        description: Filter by modified_by (exact match)
      - in: query
        name: name
        schema:
          type: string
        description: Filter by name (exact match)
      - in: query
        name: name__icontains
        schema:
          type: string
        description: Filter by name (case-insensitive partial match)
      - in: query
        name: order
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - in: query
        name: order_by
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: required
        schema:
          type: string
        description: Filter by required (exact match)
      - in: query
        name: resource
        schema:
          type: string
        description: Filter by resource (exact match)
      - in: query
        name: role_level
        schema:
          type: string
        description: Filter by role level for RBAC
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: support_level
        schema:
          type: string
        description: Filter by support_level (exact match)
      - in: query
        name: support_level__icontains
        schema:
          type: string
        description: Filter by support_level (case-insensitive partial match)
      - in: query
        name: support_url
        schema:
          type: string
        description: Filter by support_url (exact match)
      - in: query
        name: support_url__icontains
        schema:
          type: string
        description: Filter by support_url (case-insensitive partial match)
      - in: query
        name: toggle_type
        schema:
          type: string
        description: Filter by toggle_type (exact match)
      - in: query
        name: toggle_type__icontains
        schema:
          type: string
        description: Filter by toggle_type (case-insensitive partial match)
      - in: query
        name: type
        schema:
          type: string
        description: Filter by object type. Supports comma-separated values for multiple types.
      - in: query
        name: ui_name
        schema:
          type: string
        description: Filter by ui_name (exact match)
      - in: query
        name: ui_name__icontains
        schema:
          type: string
        description: Filter by ui_name (case-insensitive partial match)
      - in: query
        name: value
        schema:
          type: string
        description: Filter by value (exact match)
      - in: query
        name: value__icontains
        schema:
          type: string
        description: Filter by value (case-insensitive partial match)
      - in: query
        name: visibility
        schema:
          type: string
        description: Filter by visibility (exact match)
      tags:
      - Feature Flags
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFeatureFlagStatesList'
          description: ''
      x-ai-description: List all feature flags states
      summary: Feature flags states list
      x-summary-source: derived
  /api/v2/feature_flags/states/{id}/:
    get:
      operationId: feature_flags_states_retrieve
      description: 'A view class for displaying feature flags states.

        To add/update/remove a feature flag, see the instructions in

        `docs/apps/feature_flags.md`'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aap flag.
        required: true
      tags:
      - Feature Flags
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlagStates'
          description: ''
      x-ai-description: Retrieve single feature flags state
      summary: Feature flags states retrieve
      x-summary-source: derived
  /feature_flags/states/:
    get:
      operationId: feature_flags_states_list
      description: 'A view class for displaying feature flags states.

        To add/update/remove a feature flag, see the instructions in

        `docs/apps/feature_flags.md`'
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - Feature Flags
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFeatureFlagStatesList_2'
          description: ''
      summary: Feature flags states list
      x-summary-source: derived
    servers:
    - url: /api/eda/v1
  /feature_flags/states/{id}/:
    get:
      operationId: feature_flags_states_retrieve
      description: 'A view class for displaying feature flags states.

        To add/update/remove a feature flag, see the instructions in

        `docs/apps/feature_flags.md`'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aap flag.
        required: true
      tags:
      - Feature Flags
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlagStates_2'
          description: ''
      summary: Feature flags states retrieve
      x-summary-source: derived
    servers:
    - url: /api/eda/v1
  /api/gateway/v1/feature_flags/:
    get:
      operationId: feature_flags_list
      description: API endpoint that allows feature flags to be viewed or edited.
      parameters:
      - in: query
        name: condition
        schema:
          type: string
        description: Filter by condition (exact match)
      - in: query
        name: condition__icontains
        schema:
          type: string
        description: Filter by condition (case-insensitive partial match)
      - in: query
        name: created
        schema:
          type: string
        description: Filter by created (exact match)
      - in: query
        name: created__gt
        schema:
          type: string
        description: Filter by created (gt)
      - in: query
        name: created__gte
        schema:
          type: string
        description: Filter by created (gte)
      - in: query
        name: created__lt
        schema:
          type: string
        description: Filter by created (lt)
      - in: query
        name: created__lte
        schema:
          type: string
        description: Filter by created (lte)
      - in: query
        name: created_by
        schema:
          type: string
        description: Filter by created_by (exact match)
      - in: query
        name: description
        schema:
          type: string
        description: Filter by description (exact match)
      - in: query
        name: description__icontains
        schema:
          type: string
        description: Filter by description (case-insensitive partial match)
      - in: query
        name: id
        schema:
          type: string
        description: Filter by id (exact match)
      - in: query
        name: id__gt
        schema:
          type: string
        description: Filter by id (gt)
      - in: query
        name: id__gte
        schema:
          type: string
        description: Filter by id (gte)
      - in: query
        name: id__lt
        schema:
          type: string
        description: Filter by id (lt)
      - in: query
        name: id__lte
        schema:
          type: string
        description: Filter by id (lte)
      - in: query
        name: labels
        schema:
          type: string
        description: Filter by labels (exact match)
      - in: query
        name: modified
        schema:
          type: string
        description: Filter by modified (exact match)
      - in: query
        name: modified__gt
        schema:
          type: string
        description: Filter by modified (gt)
      - in: query
        name: modified__gte
        schema:
          type: string
        description: Filter by modified (gte)
      - in: query
        name: modified__lt
        schema:
          type: string
        description: Filter by modified (lt)
      - in: query
        name: modified__lte
        schema:
          type: string
        description: Filter by modified (lte)
      - in: query
        name: modified_by
        schema:
          type: string
        description: Filter by modified_by (exact match)
      - in: query
        name: name
        schema:
          type: string
        description: Filter by name (exact match)
      - in: query
        name: name__icontains
        schema:
          type: string
        description: Filter by name (case-insensitive partial match)
      - in: query
        name: order
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - in: query
        name: order_by
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: required
        schema:
          type: string
        description: Filter by required (exact match)
      - in: query
        name: resource
        schema:
          type: string
        description: Filter by resource (exact match)
      - in: query
        name: role_level
        schema:
          type: string
        description: Filter by role level for RBAC
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: support_level
        schema:
          type: string
        description: Filter by support_level (exact match)
      - in: query
        name: support_level__icontains
        schema:
          type: string
        description: Filter by support_level (case-insensitive partial match)
      - in: query
        name: support_url
        schema:
          type: string
        description: Filter by support_url (exact match)
      - in: query
        name: support_url__icontains
        schema:
          type: string
        description: Filter by support_url (case-insensitive partial match)
      - in: query
        name: toggle_type
        schema:
          type: string
        description: Filter by toggle_type (exact match)
      - in: query
        name: toggle_type__icontains
        schema:
          type: string
        description: Filter by toggle_type (case-insensitive partial match)
      - in: query
        name: type
        schema:
          type: string
        description: Filter by object type. Supports comma-separated values for multiple types.
      - in: query
        name: ui_name
        schema:
          type: string
        description: Filter by ui_name (exact match)
      - in: query
        name: ui_name__icontains
        schema:
          type: string
        description: Filter by ui_name (case-insensitive partial match)
      - in: query
        name: value
        schema:
          type: string
        description: Filter by value (exact match)
      - in: query
        name: value__icontains
        schema:
          type: string
        description: Filter by value (case-insensitive partial match)
      - in: query
        name: visibility
        schema:
          type: string
        description: Filter by visibility (exact match)
      tags:
      - Feature Flags
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFeatureFlagList'
          description: ''
      x-ai-description: List all feature flags
      summary: Feature flags list
      x-summary-source: derived
  /api/gateway/v1/feature_flags/{id}/:
    get:
      operationId: feature_flags_retrieve
      description: API endpoint that allows feature flags to be viewed or edited.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aap flag.
        required: true
      tags:
      - Feature Flags
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlag'
          description: ''
      x-ai-description: Returns the current state of all feature flags on the Gateway platform.
      summary: Feature flags retrieve
      x-summary-source: derived
    patch:
      operationId: feature_flags_partial_update
      description: Handle PATCH requests to update feature flag values.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aap flag.
        required: true
      tags:
      - Feature Flags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedFeatureFlagPatch'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedFeatureFlagPatch'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedFeatureFlagPatch'
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlagPatch'
          description: ''
      x-ai-description: Partially update existing feature flag
      summary: Feature flags partial update
      x-summary-source: derived
  /api/gateway/v1/feature_flags/states/:
    get:
      operationId: feature_flags_states_list
      description: 'A view class for displaying feature flags states.

        To add/update/remove a feature flag, see the instructions in

        `docs/apps/feature_flags.md`'
      parameters:
      - in: query
        name: condition
        schema:
          type: string
        description: Filter by condition (exact match)
      - in: query
        name: condition__icontains
        schema:
          type: string
        description: Filter by condition (case-insensitive partial match)
      - in: query
        name: created
        schema:
          type: string
        description: Filter by created (exact match)
      - in: query
        name: created__gt
        schema:
          type: string
        description: Filter by created (gt)
      - in: query
        name: created__gte
        schema:
          type: string
        description: Filter by created (gte)
      - in: query
        name: created__lt
        schema:
          type: string
        description: Filter by created (lt)
      - in: query
        name: created__lte
        schema:
          type: string
        description: Filter by created (lte)
      - in: query
        name: created_by
        schema:
          type: string
        description: Filter by created_by (exact match)
      - in: query
        name: description
        schema:
          type: string
        description: Filter by description (exact match)
      - in: query
        name: description__icontains
        schema:
          type: string
        description: Filter by description (case-insensitive partial match)
      - in: query
        name: id
        schema:
          type: string
        description: Filter by id (exact match)
      - in: query
        name: id__gt
        schema:
          type: string
        description: Filter by id (gt)
      - in: query
        name: id__gte
        schema:
          type: string
        description: Filter by id (gte)
      - in: query
        name: id__lt
        schema:
          type: string
        description: Filter by id (lt)
      - in: query
        name: id__lte
        schema:
          type: string
        description: Filter by id (lte)
      - in: query
        name: labels
        schema:
          type: string
        description: Filter by labels (exact match)
      - in: query
        name: modified
        schema:
          type: string
        description: Filter by modified (exact match)
      - in: query
        name: modified__gt
        schema:
          type: string
        description: Filter by modified (gt)
      - in: query
        name: modified__gte
        schema:
          type: string
        description: Filter by modified (gte)
      - in: query
        name: modified__lt
        schema:
          type: string
        description: Filter by modified (lt)
      - in: query
        name: modified__lte
        schema:
          type: string
        description: Filter by modified (lte)
      - in: query
        name: modified_by
        schema:
          type: string
        description: Filter by modified_by (exact match)
      - in: query
        name: name
        schema:
          type: string
        description: Filter by name (exact match)
      - in: query
        name: name__icontains
        schema:
          type: string
        description: Filter by name (case-insensitive partial match)
      - in: query
        name: order
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - in: query
        name: order_by
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: required
        schema:
          type: string
        description: Filter by required (exact match)
      - in: query
        name: resource
        schema:
          type: string
        description: Filter by resource (exact match)
      - in: query
        name: role_level
        schema:
          type: string
        description: Filter by role level for RBAC
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: support_level
        schema:
          type: string
        description: Filter by support_level (exact match)
      - in: query
        name: support_level__icontains
        schema:
          type: string
        description: Filter by support_level (case-insensitive partial match)
      - in: query
        name: support_url
        schema:
          type: string
        description: Filter by support_url (exact match)
      - in: query
        name: support_url__icontains
        schema:
          type: string
        description: Filter by support_url (case-insensitive partial match)
      - in: query
        name: toggle_type
        schema:
          type: string
        description: Filter by toggle_type (exact match)
      - in: query
        name: toggle_type__icontains
        schema:
          type: string
        description: Filter by toggle_type (case-insensitive partial match)
      - in: query
        name: type
        schema:
          type: string
        description: Filter by object type. Supports comma-separated values for multiple types.
      - in: query
        name: ui_name
        schema:
          type: string
        description: Filter by ui_name (exact match)
      - in: query
        name: ui_name__icontains
        schema:
          type: string
        description: Filter by ui_name (case-insensitive partial match)
      - in: query
        name: value
        schema:
          type: string
        description: Filter by value (exact match)
      - in: query
        name: value__icontains
        schema:
          type: string
        description: Filter by value (case-insensitive partial match)
      - in: query
        name: visibility
        schema:
          type: string
        description: Filter by visibility (exact match)
      tags:
      - Feature Flags
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFeatureFlagStatesList'
          description: ''
      x-ai-description: List all feature flags states
      summary: Feature flags states list
      x-summary-source: derived
  /api/gateway/v1/feature_flags/states/{id}/:
    get:
      operationId: feature_flags_states_retrieve
      description: 'A view class for displaying feature flags states.

        To add/update/remove a feature flag, see the instructions in

        `docs/apps/feature_flags.md`'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this aap flag.
        required: true
      tags:
      - Feature Flags
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlagStates'
          description: ''
      x-ai-description: Retrieve single feature flags state
      summary: Feature flags states retrieve
      x-summary-source: derived
components:
  schemas:
    PaginatedFeatureFlagStatesList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/FeatureFlagStates'
    FeatureFlagStates:
      type: object
      description: Serialize list of feature flags
      properties:
        name:
          type: string
          description: The name of the feature flag. Must follow the format of FEATURE_<flag-name>_ENABLED.
          maxLength: 64
        state:
          type: string
          readOnly: true
      required:
      - name
    PaginatedFeatureFlagStatesList_2:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=51&page_size=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=49&page_size=100
        page_size:
          type:
          - integer
          - 'null'
          example: 100
        page:
          type:
          - integer
          - 'null'
          example: 50
        results:
          type: array
          items:
            $ref: '#/components/schemas/FeatureFlagStates_2'
    FeatureFlagStates_2:
      type: object
      description: Serialize list of feature flags
      properties:
        name:
          type: string
          description: The name of the feature flag. Must follow the format of FEATURE_<flag-name>_ENABLED.
          maxLength: 64
        state:
          type: string
          readOnly: true
      required:
      - name
      - state
    PatchedFeatureFlagPatch:
      type: object
      properties:
        value:
          type: string
          description: The value used to evaluate the conditional specified.
          maxLength: 127
    FeatureFlagPatch:
      type: object
      properties:
        value:
          type: string
          description: The value used to evaluate the conditional specified.
          maxLength: 127
    FeatureFlag:
      type: object
      description: Serialize list of feature flags
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
            additionalProperties: {}
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created_by:
          type:
          - integer
          - 'null'
          readOnly: true
          description: The user who created this resource.
        modified:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        modified_by:
          type:
          - integer
          - 'null'
          readOnly: true
          description: The user who last modified this resource.
        name:
          type: string
          readOnly: true
          description: The name of the feature flag. Must follow the format of FEATURE_<flag-name>_ENABLED.
        ui_name:
          type: string
          readOnly: true
          description: The pretty name to display in the application User Interface
        condition:
          type: string
          readOnly: true
          default: boolean
          description: Used to specify a condition, which if met, will enable the feature flag.
        value:
          type: string
          description: The value used to evaluate the conditional specified.
          maxLength: 127
        required:
          type: boolean
          readOnly: true
          description: If multiple conditions are required to be met to enable a feature flag, 'required' can be used to specify the necessary conditionals.
        support_level:
          type: string
          readOnly: true
          description: The support criteria for the feature flag. Must be one of (DEVELOPER_PREVIEW or TECHNOLOGY_PREVIEW).
        visibility:
          type: boolean
          readOnly: true
          description: Controls whether the feature is visible in the UI.
        toggle_type:
          enum:
          - install-time
          - run-time
          type: string
          x-spec-enum-id: 3b0623ea623c0ae1
          readOnly: true
          description: 'Details whether a flag is toggle-able at run-time or install-time. (Default: ''run-time'').


            * `install-time` - install-time

            * `run-time` - run-time'
        description:
          type: string
    

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-feature-flags-api-openapi.yml