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

# Get Scan Policy

> Retrieves the custom scan policy for the user.



## OpenAPI

````yaml get /api/v1/user/scan-policy
openapi: 3.0.3
info:
  title: OneFirewall Offensive Security API
  description: >-
    API endpoints for the Vulnix Scanner, user management, and configuration.


    ## Authentication


    Authentication is handled via API keys. You must include your key in the
    `api-key` header with every request.


    - **Header**: `api-key: {your-api-key}`

    - **Key Format**: A single secret string provided upon creation.


    ## Organization Context


    For endpoints requiring an organization context (like scanning), you can
    specify your organization ID:


    - **Header**: `X-Org-Id: {your-org-id}`

    - **Query Parameter**: `?org_id={your-org-id}`


    If not provided, the request will use your default organization.
  version: 1.0.0
servers:
  - url: https://vulnix0.com
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /api/v1/user/scan-policy:
    get:
      tags:
        - Configuration
      summary: Get Scan Policy
      description: Retrieves the custom scan policy for the user.
      responses:
        '200':
          description: User's current scan policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanPolicyResponse'
        '404':
          description: No scan policy found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ScanPolicyResponse:
      type: object
      properties:
        email:
          type: string
          format: email
        policy:
          $ref: '#/components/schemas/ScanPolicy'
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: error
        error:
          type: string
          example: Error message description
    ScanPolicy:
      type: object
      properties:
        ports_to_scan:
          type: array
          items:
            type: integer
          example:
            - 80
            - 443
            - 8080
          description: List of ports to scan
        directory_enumeration:
          type: boolean
          example: true
          description: Enable directory enumeration
        vhost_enumeration:
          type: boolean
          example: false
          description: Enable virtual host enumeration
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: A unique API Key.

````