Scanner Ad Hoc Queries API

openapi: 3.1.0
info:
  title: Scanner Ad Hoc Queries 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: Ad Hoc Queries
  description: Run asynchronous or blocking full-text queries over indexed logs.
paths:
  /v1/start_query:
    post:
      operationId: startQuery
      tags:
      - Ad Hoc Queries
      summary: Start ad hoc query
      description: Create an asynchronous ad hoc query. Returns a query-result id (qr_id) to poll.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Query accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  qr_id:
                    type: string
                    format: uuid
              example:
                qr_id: 3f8c1c9a-0f2e-4a2b-9c1a-2d3e4f5a6b7c
        '400':
          $ref: '#/components/responses/BadRequest'
  /v1/query_progress/{qr_id}:
    get:
      operationId: getQueryProgress
      tags:
      - Ad Hoc Queries
      summary: Get query progress
      description: Check execution status and retrieve intermediate or final results for an ad hoc query. Poll about once per second.
      parameters:
      - name: qr_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: show_intermediate_results
        in: query
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Query status and results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/cancel_query/{qr_id}:
    post:
      operationId: cancelQuery
      tags:
      - Ad Hoc Queries
      summary: Cancel query
      description: Cancel an active query and free resources. Idempotent.
      parameters:
      - name: qr_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Query cancelled (no body).
  /v1/blocking_query:
    post:
      operationId: blockingQuery
      tags:
      - Ad Hoc Queries
      summary: Blocking ad hoc query
      description: Execute a synchronous ad hoc query, holding the connection open until completion or a 300-second timeout.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Completed query result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '504':
          description: Query exceeded the 300-second blocking timeout; no results returned.
components:
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid query
    NotFound:
      description: Resource not found (or resolves to a non-user index).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    QueryRequest:
      type: object
      required:
      - query
      - start_time
      - end_time
      properties:
        query:
          type: string
          description: Scanner query text.
        start_time:
          type: string
          format: date-time
          description: RFC 3339 start timestamp (inclusive).
        end_time:
          type: string
          format: date-time
          description: RFC 3339 end timestamp (exclusive).
        max_rows:
          type: integer
          default: 1000
          maximum: 100000
        max_bytes:
          type: integer
          default: 134217728
          description: Result size cap in bytes; default/max 128MB, min 1MB.
        scan_back_to_front:
          type: boolean
          default: true
    QueryResult:
      type: object
      properties:
        is_completed:
          type: boolean
        results:
          type: object
          properties:
            column_ordering:
              type: array
              items:
                type: string
            rows:
              type: array
              items:
                type: array
                items: {}
        metadata:
          type: object
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error description.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Scanner API key presented as `Authorization: Bearer <Scanner API Key>`. Create keys in Settings > API Keys.'