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

# Start a scan

> Queues a scan of one page. Poll the returned `statusUrl` for the result; a scan takes up to a minute.

Uses your daily scan (1 per 24 hours per IP, shared with the website), including when sent from this page.



## OpenAPI

````yaml /openapi.json post /scan
openapi: 3.1.0
info:
  title: Test WebMCP API
  version: 1.0.0
  description: Scan public pages for WebMCP support. Free, no key. Limited per IP address.
servers:
  - url: https://testwebmcp.com/api/v1
security: []
paths:
  /scan:
    post:
      summary: Start a scan
      description: >-
        Queues a scan of one page. Poll the returned `statusUrl` for the result;
        a scan takes up to a minute.


        Uses your daily scan (1 per 24 hours per IP, shared with the website),
        including when sent from this page.
      operationId: startScan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  description: >-
                    The page to scan. A bare hostname is treated as `https://`.
                    Only public `http` and `https` addresses.
                  example: https://example.com
      responses:
        '202':
          description: Queued.
          headers:
            Location:
              description: Same as `statusUrl`.
              schema:
                type: string
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanStarted'
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          description: >-
            The scan queue is full. Retry after `Retry-After` seconds. Doesn't
            use your scan.
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the window resets, as a Unix timestamp.
      schema:
        type: integer
    Retry-After:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  schemas:
    ScanStarted:
      type: object
      required:
        - id
        - status
        - url
        - statusUrl
        - reportUrl
      properties:
        id:
          type: string
          example: cmuelrzr40001o63kiv6vveim
        status:
          type: string
          const: queued
        url:
          type: string
          description: The URL as it will be scanned.
          example: https://example.com/
        statusUrl:
          type: string
          description: Poll this for the result.
          example: https://testwebmcp.com/api/v1/scan/cmuelrzr40001o63kiv6vveim
        reportUrl:
          type: string
          description: The report on the website.
          example: https://testwebmcp.com/scan/cmuelrzr40001o63kiv6vveim
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong.
    RateLimitError:
      type: object
      required:
        - error
        - retryAfterSeconds
        - resetAt
      properties:
        error:
          type: string
          example: >-
            The free limit is 1 scan per 24 hours per IP address, shared with
            the website.
        retryAfterSeconds:
          type: integer
          example: 86400
        retryAfterHuman:
          type: string
          example: 24 hours
        resetAt:
          type: string
          format: date-time
  responses:
    BadRequest:
      description: >-
        Missing or unreadable URL, bad JSON, or a private, internal or blocked
        address.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 10.0.0.1 is in a private or reserved range.
    RateLimited:
      description: Rate limit reached. See **Limits**.
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'

````

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