Anomalo API Keys API

openapi: 3.2.0
info:
  title: Anomalo Public API Keys API
  version: v1
  summary: Data quality monitoring, table configuration and check orchestration for the Anomalo platform.
  description: 'The Anomalo Public API (`/api/public/v1/`) drives Anomalo''s data quality monitoring platform: connect and refresh warehouses, configure which tables are monitored, create and run data quality checks, read check-run results and table data profiles, manage table/check labels, administer users, API keys and access groups, record table lineage edges, and manage notification channels.'
  contact:
    name: Anomalo
    url: https://www.anomalo.com/contact-us/
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  x-derived-from: https://pypi.org/project/anomalo/0.46.0/
  x-derived-by: API Evangelist enrichment pipeline
  x-unofficial: true
servers:
- url: https://{instance}/api/public/v1
  description: Anomalo is deployed per-tenant. The client reads the host from the `ANOMALO_INSTANCE_HOST` environment variable.
  variables:
    instance:
      default: app.anomalo.com
      description: Your Anomalo instance host, e.g. app.anomalo.com or my-company.anomalo.com
security:
- AnomaloToken: []
tags:
- name: API Keys
paths:
  /api-keys:
    get:
      operationId: list_api_keys_for_current_user
      summary: List api keys for current user
      tags:
      - API Keys
      x-client-methods:
      - list_api_keys_for_current_user
      parameters:
      - name: limit
        in: query
        required: false
        schema: {}
      - name: offset
        in: query
        required: false
        schema: {}
      responses:
        '200':
          description: Successful response. The client returns the decoded JSON body.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: create_api_key_for_current_user
      summary: Create api key for current user
      tags:
      - API Keys
      x-client-methods:
      - create_api_key_for_current_user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description: {}
                expires: {}
              required:
              - description
              - expires
              additionalProperties: false
      responses:
        '200':
          description: Successful response. The client returns the decoded JSON body.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
  /api-keys/{api_key_id}:
    delete:
      operationId: revoke_api_key_for_current_user
      summary: Revoke api key for current user
      tags:
      - API Keys
      x-client-methods:
      - revoke_api_key_for_current_user
      parameters:
      - name: api_key_id
        in: path
        required: true
        description: Path identifier `api_key_id`.
        schema:
          type: integer
      responses:
        '200':
          description: Successful response. The client returns the decoded JSON body.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  responses:
    BadRequest:
      description: Bad request. Raised by the client as BadRequestException (not retried).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not permitted for the active organization or resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Server error. The first-party client retries these up to 5 times with exponential jitter backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: Error body. The first-party client raises BadRequestException for 4xx and RuntimeError for 5xx, carrying the raw response text; Anomalo does not publish a documented error envelope schema.
      additionalProperties: true
  securitySchemes:
    AnomaloToken:
      type: apiKey
      in: header
      name: X-Anomalo-Token
      description: Anomalo API secret token. The first-party client sends it as `X-Anomalo-Token` by default (`legacy_auth=True`), read from the `ANOMALO_API_SECRET_TOKEN` environment variable.
    BearerToken:
      type: http
      scheme: bearer
      description: 'Anomalo API secret token sent as `Authorization: Bearer <token>`. Selected in the first-party client with `legacy_auth=False`.'