> ## Documentation Index
> Fetch the complete documentation index at: https://docs.attaxr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a scan

> Fetch one scan by id. Falls back to the linked schedule when the id names a schedule.



## OpenAPI

````yaml /api/openapi.json get /api/scans/{id}
openapi: 3.1.0
info:
  title: Aquila API
  version: 1.0.0
  description: >-
    Event-driven reconnaissance platform API. All /api/* routes except
    /api/public/* require an authenticated session (cookie), an X-Api-Key
    header, or a bearer token. Auth endpoints under /api/auth/* are generated by
    Better Auth.
servers:
  - url: https://aquila.attaxr.com
  - url: http://localhost
security: []
tags:
  - name: AI
  - name: Agents
  - name: Bulk Delete
  - name: Chat
  - name: Constraints
  - name: Dashboard
  - name: Events
  - name: JS
  - name: JS Analysis
  - name: JS Monitoring
  - name: Leads
  - name: MCP Key
  - name: Models
  - name: Notification Channels
  - name: Notification Event Preferences
  - name: Notifications
  - name: OOB
  - name: Provider Keys
  - name: Public Shares
  - name: Reinforcements
  - name: Reports
  - name: Scans
  - name: Schedules
  - name: Shares
  - name: Tools
  - name: User Profiles
  - name: V1
  - name: Vulnerabilities
  - name: Workflows
paths:
  /api/scans/{id}:
    get:
      tags:
        - Scans
      summary: Get a scan
      description: >-
        Fetch one scan by id. Falls back to the linked schedule when the id
        names a schedule.
      operationId: getApiScansId
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The scan.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  _id:
                    type: string
                  userId:
                    type: string
                  target:
                    type: string
                  type:
                    type: string
                  scope:
                    default: []
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        value:
                          type: string
                      required:
                        - type
                        - value
                      additionalProperties: false
                  workflowSteps:
                    default: []
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        tool:
                          type: string
                        args:
                          default: []
                          type: array
                          items:
                            type: string
                        env:
                          default: {}
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: string
                        retryCount:
                          default: 0
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        timeout:
                          default: 300
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        status:
                          type: string
                      required:
                        - name
                        - tool
                        - args
                        - env
                        - retryCount
                        - timeout
                      additionalProperties: {}
                  status:
                    default: pending
                    type: string
                    enum:
                      - pending
                      - queued
                      - running
                      - completed
                      - failed
                      - cancelled
                  workflowId:
                    type: string
                  startedAt: {}
                  completedAt: {}
                  error:
                    type: string
                  metadata:
                    default: {}
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  createdAt:
                    default: '2026-09-18T11:34:11.687Z'
                  updatedAt:
                    default: '2026-09-18T11:34:11.687Z'
                required:
                  - userId
                  - target
                  - type
                  - scope
                  - workflowSteps
                  - status
                  - metadata
                  - createdAt
                  - updatedAt
                additionalProperties: false
        '401':
          description: No valid session cookie or API key.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: No scan found for this id.
          content:
            application/json:
              schema: {}
      security:
        - apiKeyCookie: []
        - apiKeyHeader: []
        - bearerAuth: []
components:
  securitySchemes:
    apiKeyCookie:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Browser session cookie set by Better Auth sign-in.
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Personal API key (aquila_… prefix; settings → API keys).
    bearerAuth:
      type: http
      scheme: bearer
      description: Personal API key sent as a bearer token.

````