AnomalyArmor API Keys API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai API Keys API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged api-keys across 3 of this provider''s published API definitions: anomalyarmor.ai-openapi.json, app.anomalyarmor.ai-openapi.json, docs.anomalyarmor.ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8000
  description: Development server
- url: https://api.anomalyarmor.ai
  description: Production server
tags:
- name: API Keys
paths:
  /api/v1/api-keys:
    get:
      tags:
      - API Keys
      summary: List Api Keys
      description: 'List API keys for the current organization.


        Returns all API keys created by users in the organization.

        By default, only active (non-revoked) keys are returned.'
      operationId: list_api_keys_api_v1_api_keys_get
      parameters:
      - name: include_revoked
        in: query
        required: false
        schema:
          type: boolean
          description: Include revoked keys
          default: false
          title: Include Revoked
        description: Include revoked keys
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Max records to return
          default: 50
          title: Limit
        description: Max records to return
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Records to skip
          default: 0
          title: Offset
        description: Records to skip
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - API Keys
      summary: Create Api Key
      description: 'Create a new API key.


        The full API key is only returned once in this response.

        Store it securely - you won''t be able to retrieve it again.


        Requires sufficient permissions based on your subscription tier.'
      operationId: create_api_key_api_v1_api_keys_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAPIKeyRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/api-keys/usage:
    get:
      tags:
      - API Keys
      summary: Get Api Key Usage
      description: 'Get API key usage and limits for the current organization.


        Returns the current number of keys and rate limits based on your

        subscription tier. API key count is unlimited; usage is controlled

        via rate limits and monthly call limits.'
      operationId: get_api_key_usage_api_v1_api_keys_usage_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/api-keys/{key_id}:
    delete:
      tags:
      - API Keys
      summary: Revoke Api Key
      description: 'Revoke an API key.


        Revoked keys can no longer be used for authentication.

        This action cannot be undone.'
      operationId: revoke_api_key_api_v1_api_keys__key_id__delete
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Key Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - API Keys
      summary: Get Api Key
      description: 'Get details of a specific API key.


        Note: The full key is never returned - only prefix and suffix for identification.'
      operationId: get_api_key_api_v1_api_keys__key_id__get
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Key Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateAPIKeyRequest:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
          description: Human-readable name for the key
        scope:
          type: string
          title: Scope
          description: 'Permission scope: read-only, read-write, or admin'
          default: read-only
      type: object
      required:
      - name
      title: CreateAPIKeyRequest
      description: Request to create a new API key.
      example:
        name: Airflow Production
        scope: read-only
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    StandardResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - {}
          - type: 'null'
          title: Data
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: StandardResponse
      description: Standard API response wrapper.
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json