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

# Create Scan



## OpenAPI

````yaml /api-reference/openapi.json post /api/scans
openapi: 3.1.0
info:
  title: Blindsight API
  version: 0.1.0
  description: >-
    The full Blindsight REST surface, generated from the running application.
    Replace the server host with your own deployment.


    For the Runtime Security integration surface (scan, proxy, tool calls) see
    the Runtime Security spec, which is hand written and carries worked
    examples.
servers:
  - url: https://api.your-blindsight.com
    description: Your Blindsight deployment
security: []
tags:
  - name: Authentication
  - name: Single sign-on
  - name: Social sign-in
  - name: SCIM provisioning
  - name: Projects
  - name: Datasets
  - name: Uploads and imports
  - name: Scans
  - name: Schedules
  - name: Healing
  - name: RAG corpora
  - name: Custom rules
  - name: Playground
  - name: Search and activity
  - name: Apps
  - name: Devices and agents
  - name: Discovery
  - name: DLP policy
  - name: DLP installation
  - name: Compliance
  - name: Audit trail
  - name: Reports
  - name: Export templates
  - name: Workspaces
  - name: Users
  - name: Invitations
  - name: API keys
  - name: Settings
  - name: Directory sync
  - name: Integrations
  - name: Pending actions
  - name: License
  - name: Onboarding
  - name: Support
  - name: Platform operations
  - name: Webhooks
paths:
  /api/scans:
    post:
      tags:
        - Scans
      summary: Create Scan
      operationId: create_scan_api_scans_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ScanCreate:
      properties:
        scan_type:
          type: string
          title: Scan Type
        dataset_dir:
          type: string
          title: Dataset Dir
        params:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Params
      type: object
      required:
        - scan_type
        - dataset_dir
      title: ScanCreate
    ScanRead:
      properties:
        id:
          type: string
          title: Id
        scan_type:
          type: string
          title: Scan Type
        dataset_dir:
          type: string
          title: Dataset Dir
        dataset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Dataset Id
        dataset_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Dataset Name
        params:
          additionalProperties: true
          type: object
          title: Params
        engine_params:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Engine Params
        status:
          type: string
          title: Status
        progress:
          type: integer
          title: Progress
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
        started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
        duration_seconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Duration Seconds
        total_issues:
          type: integer
          title: Total Issues
          default: 0
        critical_count:
          type: integer
          title: Critical Count
          default: 0
        high_count:
          type: integer
          title: High Count
          default: 0
        medium_count:
          type: integer
          title: Medium Count
          default: 0
        low_count:
          type: integer
          title: Low Count
          default: 0
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - scan_type
        - dataset_dir
        - params
        - status
        - progress
        - message
        - created_at
        - updated_at
      title: ScanRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.