CG Scanning API V2
latest
  • latest
  • 5.3.0
  • 5.4.2
Home
Docs
Home
Docs
latest
  • latest
  • 5.3.0
  • 5.4.2
latest
  • latest
  • 5.3.0
  • 5.4.2
  1. Scans
  • Scanning API
    • Getting Started
    • Authentication
    • Common Error Responses
    • Filtering Data
    • Authentication
      • User Confirmation
        • Confirm a User
        • Show confirmation form
      • User Invitation
        • Accept an invitation
        • Pre-Accept invitation check
      • Password Reset
        • Forgot Password
        • Reset Password
      • Impersonation
        • Impersonate user
        • Impersonate user
      • MFA
        • Check 2fa
        • Send SMS OTP
      • Sign in authentication
      • Sign in with recovery code
      • Sign out authentication
      • SSO Link login
    • Targets
      • List targets
      • Create Target
      • Show a target
      • Updates a target
      • Delete a target
      • Delete targets
    • Scans
      • Scan Histories
        • List of history for a scan
        • History details for a scan
      • Scan Hosts
        • List of hosts for a scan
        • Host details for a scan
      • Scan Vulnerabilities
        • List of vulnerabilities for a scan
        • Show vulnerability details
        • Statistics for a scan
      • Scan Profiles (Configs)
        • List Activated Scan Profiles
      • List scans
        GET
      • Create Scan
        POST
      • Show a scan
        GET
      • Updates a scan
        PUT
      • Delete a scan
        DELETE
      • Delete scans
        DELETE
      • Start a scan
        POST
      • Stop a scan
        POST
      • List upcoming scans
        GET
      • List recent scans that have been completed
        GET
      • List of the running scans
        GET
      • Create Scan from Wizard
        POST
    • Reports
      • List Reports
      • Show a report
      • Delete a report
      • Delete reports
      • Generates a report file
      • Downloads a report file
      • Check if a report file exists
      • Verifies file integrity by comparing hashes
    • Vulnerabilities
      • List of vulnerabilities
      • Vulnerability details
      • Total Vulnerabilities (widget)
      • Top Vulnerabilities (widget)
      • PCI Compliant (widget)
      • Send prompt about a given Vulnerability
      • Chat history about a given Vulnerability
    • Exceptions
      • List Exceptions
      • Create Exception
      • Update Exception
      • Show an exception
      • Delete an exception
      • Show exception details
      • Delete exceptions
      • Activate exceptions
      • Reset exceptions
      • Show the exceptions statistics
    • Schedules
      • List Schedules
      • Create Schedule
      • Updates a schedule
      • Show a schedule
      • Delete a schedule
      • Delete schedules
      • Calculate First Time Schedule Date
      • Calculate Next Schedule Dates
    • Webhooks
      • Deliveries
        • List all deliveries for a webhook
        • Get a delivery for a webhook
      • List all webhooks
      • Create a webhook
      • Show a webhook
      • Update a webhook
      • Delete a webhook
      • Activate a webhook
      • Deactivate a webhook
    • Advanced Reports
      • List Advanced Reports
      • Create an advanced report
      • Show an advanced report
      • Update an advanced report
      • Delete an advanced report
      • Delete advanced reports
      • Generates an advanced report file
      • Downloads an advanced report file
    • Audit
      • Get all events
      • Get event by id
    • Notifications
      • List Notifications
      • Show a notification
      • Delete a notification
      • Mark as read a notification
      • Mark as seen a notification
      • Mark as read all notifications
      • Mark as seen all notifications
    • Hosts
      • List of hosts
      • Host details
      • List of most vulnerable hosts
    • Scanners
      • List scanners
      • Create scanner
      • Show scanner
      • Update scanner
      • Delete scanner
      • List activated scanners
      • Activate scanner
      • Deactivate scanner
      • Update scanner app type
      • Assign a scanner to an organization
      • Verify a scanner
    • Port Lists
      • List port lists
      • Create a port list
      • Show a port list
      • Update a port list
      • Delete a port list
      • List activated port lists
      • Add a port range to a port list
      • Delete a port range to a port list
      • Activate a port list
      • Deactivate a port list
      • Updates the app_type of a port list
      • Sync the a port lists
    • Credentials
      • List Credentials
      • Show Credential
      • Delete Credential
      • Create Credential
      • Update Credential
    • User
      • User 2FA
        • Enable 2FA
        • Verify 2FA installation
        • Disable 2FA
        • Lookup phone number
        • Default 2FA method
        • Generate Recovery Codes
        • Get Recovery Codes
      • User Preferences
        • Get users notification preferences
        • Change users product
        • Enable user's event notification preference
        • Disable user's event notification preference
      • Get current user
      • Update current user
      • Change current user password
      • Get current user active plans (Not implemented yet)
      • Get organization members
      • Get current user products
      • Get current organization
      • Update current organization
      • Get subscriptions history
      • Change users product
      • Checks if authorization token is valid
      • Get current user permissions
      • Check if the user can be deleted
      • Delete my account
      • Generates a new access token
      • Revokes the current access token
      • Transfers all the resources from the user to another user
    • Organizations
      • Organization Subscriptions
        • Retrieves all subscriptions of organization
        • Retrieves all active subscriptions of organization
        • Show a subscription of organization
        • Update organization's subscription
        • Assign features to a subscription
        • Revoke features from a subscription
      • Subscribe to a plan
      • List organizations
      • Create Organization
      • List dependent subscriptions
      • Retrieve an organization
      • Update an organization
      • Delete an organization
      • Subscribe an organization to a plan
      • Unsubscribe an organization from a plan
      • Change users Organization
      • Export organizations
    • Users
      • List Users
      • Create User
      • Show User
      • Update User
      • Delete a User
      • Create Customer
      • Invite User
      • Resend Confirmation Instructions
      • Import Users
      • Check if a user can be deleted
      • Inherit all the resources from a user
      • Export all users to a CSV file
      • Set partner
      • Unset partner
    • Whitelabel Settings
      • Show the white label settings
      • Show the white label settings
      • Update white label settings
    • Schemas
      • Schemas
        • errors_map
        • errorObject
        • not_found
        • ErrorResponse
        • forbidden
        • unauthorized
        • unprocessable_entity
        • pagination
        • meta
        • target
        • scan
        • targetAttributes
        • targetResponse
        • targetsResponse
        • product
        • productsResponse
  • SAQ API
    • List all SAQs
    • Get SAQ (JSON) or Download SAQ (PDF)
    • List Available SAQ Types
    • Get SAQ Type Template
    • Create a New SAQ
    • Delete an SAQ
    • Clone an SAQ
    • Approve an SAQ
    • Set SAQ as a template
Home
Docs
Home
Docs
latest
  • latest
  • 5.3.0
  • 5.4.2
latest
  • latest
  • 5.3.0
  • 5.4.2
  1. Scans

Scan Profiles

Scan Profiles (also referred to as Scan Configurations) define how a scan is executed.
They describe the technical behavior of a scan rather than what is scanned.
A scan profile controls parameters such as:
Which vulnerability tests are executed
Scan intensity and performance tuning
Network and port scanning behavior
Detection depth and accuracy
Scan profiles allow the same target (host, IP range, or asset) to be scanned using different strategies, depending on security requirements, compliance needs, or performance constraints.

Relationship to Scans#

When creating a scan via the API:
A scan profile is referenced, not embedded.
The profile determines scan behavior at runtime.
Example flow:
List available scan profiles via /v2/scans/profiles/activeted
Select the appropriate profile ID
Create a scan referencing that profile

Product-Specific Scan Profiles & Restrictions#

Scan Profiles are product-specific. Each scanning product (e.g. PCI, VRMS, Penetration Testing, etc.) exposes its own set of available scan profiles, aligned with the technical and regulatory requirements of that product.
End users cannot create, modify, or update scan profiles through the API or the UI. All scan profiles are system-defined and maintained to ensure scan integrity, consistency, and compliance.
PCI Product – Special Restriction
For the PCI Compliance (ASV) product, the scan profile is:
Pre-defined and fixed
Not configurable or replaceable
Mandatory for all PCI scans
This restriction exists due to ASV PCI DSS requirements, which mandate a specific scanning configuration. Allowing profile changes would invalidate compliance and certification requirements.

Other Products#

For all non-PCI products (e.g. VRMS, Penetration Testing, Dark Web):
Multiple scan profiles may be available
Different profiles can be selected instead of the default
Profiles allow flexibility in scan depth, performance, and coverage
However, even for these products, profiles remain read-only for end users and can only be selected, not modified.
Modified at 2026-01-02 14:04:00
Previous
Statistics for a scan
Next
List Activated Scan Profiles
Built with