CG Scanning API V2
latest
  • latest
  • v5.0.0-beta1
HomeDocs
HomeDocs
latest
  • latest
  • v5.0.0-beta1
  1. Reports
  • 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
    • MFA
      • Check 2fa
      • Send SMS OTP
    • Impersonation
      • Impersonate user
      • Impersonate user
    • Sign in authentication
      POST
    • Sign out authentication
      DELETE
  • 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
      POST
    • List organizations
      GET
    • Create Organization
      POST
    • List dependent subscriptions
      GET
    • Show an organization
      GET
    • Update an organization
      PUT
    • Delete an organization
      DELETE
    • Subscribe an organization to a plan
      POST
    • Unsubscribe an organization from a plan
      POST
    • Move a user from one organization to another
      PUT
    • Export all organizations to a CSV file
      GET
  • 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
  • User
    • User 2FA
      • Enable 2FA
      • Verify 2FA installation
      • Disable 2FA
      • Lookup phone number
      • Default 2FA method
    • 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
    • Transfers all the resources from the user to another user
    • Delete my account
  • Targets
    • List targets
    • Create Target
    • Show a target
    • Updates a target
    • Delete a target
    • Delete targets
  • 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
  • Scans
    • 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
      GET
    • Show a report
      GET
    • Delete a report
      DELETE
    • Delete reports
      DELETE
    • Generates a report file
      GET
    • Downloads a report file
      GET
    • Check if a report file exists
      GET
  • 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
  • Vulnerabilities
    • List of vulnerabilities
    • Vulnerability details
    • Total Vulnerabilities (widget)
    • Top Vulnerabilities (widget)
    • PCI Compliant (widget)
    • AI sessions of Vulnerabilities
    • AI session of Vulnerability
    • Chat history about a given Vulnerability
    • Send prompt 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
  • 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
  • Subscriptions
  • Hosts
    • List of hosts
    • Host details
    • List of most vulnerable hosts
  • 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
  • Whitelabel
  • 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
  • Webhook Events
    • Scan Events
  • Audit
    • Get all events
    • Get event by id
    • Delete event by id
  • Whitelabel Settings
    • Show the white label settings
    • Update white label settings
  1. Reports

Generates a report file

GET
/v2/reports/{id}/generate
Reports
Last modified:2024-11-22 19:53:37
Generate a report file

Request

Path Params
id
string 
required
Query Params
type
enum<string> 
required
Allowed values:
detailedattestationexecutivevulnerability_assessmentvulnerability_summaryexecutive_vrmspenetrationpenetration_executivedarkweb_executiveremediationpenetration_detailedjson_filejson
include_attestation
boolean 
optional
extended
boolean 
optional
includes the Failed Exploited Attempts and Vulnerability Activity sections in the generated penetration PDF file when set to true

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 GET '/v2/reports//generate?type'

Responses

🟢200OK
application/json
Success
Body
object {0}
Example
{}
🟠401Unauthorized
🟠404Record Not Found
🟠422Parameter Error
Modified at 2024-11-22 19:53:37
Previous
Delete reports
Next
Downloads a report file
Built with