CG Scanning API V2
latest
  • latest
  • 5.2.0
HomeDocs
HomeDocs
latest
  • latest
  • 5.2.0
  1. Exceptions
  • 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
      POST
    • Sign in with recovery code
      POST
    • Sign out authentication
      DELETE
  • Targets
    • List targets
      GET
    • Create Target
      POST
    • Show a target
      GET
    • Updates a target
      PUT
    • Delete a target
      DELETE
    • Delete targets
      DELETE
  • 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
    • List scans
    • Create Scan
    • Show a scan
    • Updates a scan
    • Delete a scan
    • Delete scans
    • Start a scan
    • Stop a scan
    • List upcoming scans
    • List recent scans that have been completed
    • List of the running scans
    • Create Scan from Wizard
  • 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
  • Vulnerabilities
    • List of vulnerabilities
    • Vulnerability details
    • Total Vulnerabilities (widget)
    • Top Vulnerabilities (widget)
    • PCI Compliant (widget)
    • (AI) Send prompt about a given Vulnerability
    • (AI) Chat history about a given Vulnerability
  • Exceptions
    • List Exceptions
      GET
    • Create Exception
      POST
    • Update Exception
      PUT
    • Show an exception
      GET
    • Delete an exception
      DELETE
    • Show exception details
      GET
    • Delete exceptions
      DELETE
    • Activate exceptions
      PUT
    • Reset exceptions
      PUT
    • Show the exceptions statistics
      GET
  • 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
  • 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
    • (Admin) 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
  1. Exceptions

Create Exception

POST
/v2/exceptions
Exceptions
Last modified:2025-04-24 10:59:46
This endpoint allows you to create an exception for a specific vulnerability based on its NVT ID.
Exceptions can be scoped to affect vulnerabilities in different ways,
depending on the attributes you provide:

Scope by Host and Port:#

If you specify the hosts and/or port attributes, the exception will apply to all occurrences of the
specified vulnerability across the given host(s) and port(s).
This can affect multiple scans that include the same vulnerability on the specified host(s) and port(s).

Scope by Scan:#

If you specify the scan attribute (scan ID), the exception will apply to all occurrences of the
specified vulnerability within that specific scan only.

Request

Body Params application/json
exception
object 
optional
text
string 
required
The exception name
Example:
My Exception
hosts
string 
optional
The hosts to which this exception applies
Example:
178.151.13.5
port
integer 
optional
The port of the hosts to which this exception applies
Example:
8080
task
string <uuid>
optional
DEPRECATED: Use scan attribute instead
scan
string <uuid>
optional
The scan uuid to which this exception applies
new_severity
number 
optional
Severity
Example:
2
nvt
string 
required
The NVT
Example:
1.3.6.1.4.1.25623.1.0.815255
Example
{
    "exception": {
        "text": "My Exception",
        "hosts": "178.151.13.5",
        "port": 8080,
        "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
        "scan": "a7a2f3fe-ff95-4c3f-9ff0-56fb58648122",
        "new_severity": 2,
        "nvt": "1.3.6.1.4.1.25623.1.0.815255"
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/exceptions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "exception": {
        "text": "My Exception",
        "hosts": "178.151.13.5",
        "port": 8080,
        "task": "4879b8a6-fb3e-4a0d-aef8-b0ea469ac85c",
        "scan": "a7a2f3fe-ff95-4c3f-9ff0-56fb58648122",
        "new_severity": 2,
        "nvt": "1.3.6.1.4.1.25623.1.0.815255"
    }
}'

Responses

🟢201Created
Exception created
This response does not have a body.
🟠401Unauthorized
🟠422Parameter Error
Modified at 2025-04-24 10:59:46
Previous
List Exceptions
Next
Update Exception
Built with