Scanner Info API

openapi: 3.1.0
info:
  title: Scanner Ad Hoc Queries Info API
  version: v1
  description: Scanner is a cloud-native security data platform that indexes logs directly in Amazon S3 for fast full-text search, continuous streaming detections, and programmatic access to security data. This REST API (v1) covers searchable indexes, detection rules, event sinks, lookup tables, ad hoc queries, and account/query-capacity info. Authentication is a Scanner API key presented as an HTTP Bearer token. Most operations are tenant-scoped and require a `tenant_id`. The API base URL is environment-specific and shown in Settings > API Keys inside the Scanner app.
  contact:
    name: Scanner
    url: https://docs.scanner.dev/scanner/
  x-provenance:
    generated: '2026-07-21'
    method: generated
    source: https://docs.scanner.dev/scanner/using-scanner-complete-feature-reference/developer-tools/api.md
servers:
- url: https://{environment}.scanner.dev
  description: Environment-specific Scanner host. Find your environment/base URL in Settings > API Keys (the MCP endpoint uses the parallel form https://mcp.{environment}.scanner.dev/v1/mcp).
  variables:
    environment:
      default: your-env-here
      description: Your Scanner environment identifier from Settings > API Keys.
security:
- bearerAuth: []
tags:
- name: Info
  description: Account and query-capacity metrics.
paths:
  /v1/info/query_capacity:
    get:
      operationId: getQueryCapacity
      tags:
      - Info
      summary: Get query capacity
      description: Retrieve query capacity metrics and configuration for a tenant.
      parameters:
      - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          description: Query capacity metrics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCapacity'
        '400':
          $ref: '#/components/responses/BadRequest'
components:
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid query
  parameters:
    TenantId:
      name: tenant_id
      in: query
      required: true
      schema:
        type: string
      description: Unique identifier for the tenant.
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error description.
    QueryCapacity:
      type: object
      properties:
        this_month_used_query_capacity_gb:
          type: number
        this_month_provisioned_query_capacity_gb:
          type: number
        this_month_on_demand_query_capacity_gb:
          type: number
        number_of_days_this_month:
          type: number
        contract_provisioned_query_capacity_gb_per_day:
          type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Scanner API key presented as `Authorization: Bearer <Scanner API Key>`. Create keys in Settings > API Keys.'