Unleash Unknown Flags API

Endpoints related to unknown flags.

OpenAPI Specification

unleash-unknown-flags-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Unleash Admin Addons Unknown Flags API
  version: 7.4.1
  description: Create, update, and delete [Unleash addons](https://docs.getunleash.io/addons).
servers:
- url: https://app.unleash-instance.example.com
  description: Your Unleash instance (replace with your actual URL)
security:
- apiKey: []
- bearerToken: []
tags:
- name: Unknown Flags
  description: Endpoints related to unknown flags.
paths:
  /api/admin/metrics/unknown-flags:
    get:
      operationId: getUnknownFlags
      tags:
      - Unknown Flags
      summary: Get Unknown Flags
      description: Returns a list of unknown flag reports from the last 24 hours, if any. Maximum of 1000.
      responses:
        '200':
          description: unknownFlagsResponseSchema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unknownFlagsResponseSchema'
components:
  schemas:
    unknownFlagSchema:
      type: object
      additionalProperties: false
      required:
      - name
      - lastSeenAt
      description: An unknown flag report
      properties:
        name:
          type: string
          description: The name of the unknown flag.
          example: my-unknown-flag
        lastSeenAt:
          type: string
          format: date-time
          description: The date and time when the unknown flag was last reported.
          example: '2023-10-01T12:00:00Z'
        lastEventAt:
          type: string
          format: date-time
          description: The date and time when the last event for the unknown flag name occurred, if any.
          example: '2023-10-01T12:00:00Z'
          nullable: true
        reports:
          type: array
          description: The list of reports for this unknown flag.
          items:
            type: object
            additionalProperties: false
            required:
            - appName
            - environments
            properties:
              appName:
                type: string
                description: The name of the application that reported the unknown flag.
                example: my-app
              environments:
                type: array
                description: The list of environments where this application reported the unknown flag.
                items:
                  type: object
                  additionalProperties: false
                  required:
                  - environment
                  - seenAt
                  properties:
                    environment:
                      type: string
                      description: The environment in which the unknown flag was reported.
                      example: production
                    seenAt:
                      type: string
                      format: date-time
                      description: The date and time when the unknown flag was last seen in this environment.
                      example: '2023-10-01T12:00:00Z'
    unknownFlagsResponseSchema:
      type: object
      additionalProperties: false
      required:
      - unknownFlags
      description: A list of unknown flag reports
      properties:
        unknownFlags:
          description: The list of recently reported unknown flags.
          type: array
          items:
            $ref: '#/components/schemas/unknownFlagSchema'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: API key needed to access this API
    bearerToken:
      type: http
      scheme: bearer
      description: API key needed to access this API, in Bearer token format