CG Scanning API V2
v5.0.0-beta1
  • latest
  • v5.0.0-beta1
HomeDocs
HomeDocs
v5.0.0-beta1
  • latest
  • v5.0.0-beta1
  1. Scan Hosts
  • Getting Started
  • Authentication
    • Confirm a User
      POST
    • Show confirmation form
      GET
    • Accept an invitation
      PUT
    • Pre-Accept invitation check
      GET
    • Forgot Password
      POST
    • Reset Password
      PUT
    • MFA Phase
      POST
    • Sign out authentication
      DELETE
    • Impersonate user
      POST
    • Impersonate user
      DELETE
    • Check 2fa
      PUT
    • Send SMS OTP
      PUT
  • AdvancedReports
    • List Advanced Reports
      GET
    • Create an advanced report
      POST
    • Show an advanced report
      GET
    • Update an advanced report
      PUT
    • Delete an advanced report
      DELETE
    • Delete advanced reports
      DELETE
    • Generates an advanced report file
      GET
    • Downloads an advanced report file
      GET
  • Targets
    • List targets
      GET
    • Create Target
      POST
    • Show a target
      GET
    • Updates a target
      PUT
    • Delete a target
      DELETE
    • Delete targets
      DELETE
  • 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
  • Plans
    • Retrieves all plans
    • Creates a plan
    • Retrieves a plan
    • Updates a plan
    • Deletes a plan
    • Retrieves the default plan of specific product
    • Assign features to a plan
    • Revoke features from a plan
    • Retrieves all features
    • Sets plan as default
    • Default plan unset
    • Retrieves the default plans of all products
  • Products
    • Retrieves all products
    • Retrieves a product
  • Subscriptions
    • Retrieves all subscriptions
    • Show a subscription
  • Vulnerabilities
    • List of vulnerabilities
    • Vulnerability details
    • Total Vulnerabilities (widget)
    • Top Vulnerabilities (widget)
    • PCI Compliant (widget)
  • 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
  • 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
  • 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
  • Organizations
    • Subscribe to a plan
    • List organizations
    • Create Organization
    • List dependent subscriptions
    • Show an organization
    • Update an organization
    • Delete an organization
    • Subscribe an organization to a plan
    • Unsubscribe an organization from a plan
    • Move a user from one organization to another
    • Export all organizations to a CSV file
  • 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
  • Whitelabel
    • Show the white label settings
    • Update white label settings
  • PortLists
    • 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
  • getPortalSettings
    • Get portal settings
  • Scan Hosts
    • List of hosts for a scan
      GET
    • Host details for a scan
      GET
  • Scan Vulnerabilities
    • List of vulnerabilities for a scan
    • Show vulnerability details
    • Statistics for a scan
  • Schedules
    • List Schedules
    • Create Schedule
    • Updates a schedule
    • Show a schedule
    • Delete a schedule
    • Delete schedules
  • User
    • 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
  • 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
  • Scans
    • 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
  • User 2FA
    • Enable 2FA
    • Verify 2FA installation
    • Disable 2FA
    • Lookup phone number
    • Default 2FA method
  • UserPreferences
    • Get users notification preferences
    • Change users product
    • Enable user's event notification preference
    • Disable user's event notification preference
  • webhooks
    • List all deliveries for a webhook
    • Get a delivery for a webhook
  • Webhooks
    • List all webhooks
    • Create a webhook
    • Show a webhook
    • Update a webhook
    • Delete a webhook
    • Activate a webhook
    • Deactivate a webhook
  • Audit
    • Get all events
    • Get event by id
    • Delete event by id
  1. Scan Hosts

List of hosts for a scan

GET
/v2/scans/{scan_id}/hosts
Scan Hosts
Last modified:2024-11-12 10:01:40
This endpoint returns a list of hosts for a scan.
The list includes the hosts for the last scan (last report).

Request

Path Params
scan_id
string 
required
Query Params
page
integer 
optional
Page number. Default: 1
per_page
integer 
optional
Number of records per page. Default: 10. Max: 100
date_range_start
string 
optional
Start date for date range filter. Format: YYYY-MM-DD hh:mm:ss
date_range_end
string 
optional
End date for date range filter. Default: current time. Format: YYYY-MM-DD hh:mm:ss
relative_date_range
string 
optional
Relative date range filter.
Available units: (s)econds, (m)inutes, (h)ours, (d)ays, (M)onths, (y)ears. (q)uarter
Example: Get the results for the last 10 days - 10d.
Get the results from the first quarter at 2020 - 1q2020
q
string 
optional
Search by host. Usage q[column]='word'
sort_by
string 
optional
Sort by host, high, max_severity. Usage: column_name_desc or column_name_asc

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/scans//hosts'

Responses

🟢200OK
application/json
List of hosts for a scan
Body
object {0}
Example
{}
🟠401Unauthorized
🟠404Record Not Found
Modified at 2024-11-12 10:01:40
Previous
Get portal settings
Next
Host details for a scan
Built with