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. Notifications
  • 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
    • Create Target
    • Show a target
    • Updates a target
    • Delete a target
    • Delete targets
  • 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
      GET
    • Show a notification
      GET
    • Delete a notification
      DELETE
    • Mark as read a notification
      PUT
    • Mark as seen a notification
      PUT
    • Mark as read all notifications
      PUT
    • Mark as seen all notifications
      PUT
  • 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
    • Host details for a scan
  • 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. Notifications

List Notifications

GET
/v2/notifications
Notifications
Last modified:2024-11-12 10:01:31
Get a list of notifications

Request

Query Params
unread
boolean 
optional
Fetch only the notifications that are unread

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/notifications'

Responses

🟢200OK
application/json
Notification list
Body
data
array [object {3}] 
optional
id
string <uuid>
optional
type
string 
optional
attributes
object 
optional
meta
object 
optional
Example
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "attributes": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "type": "string",
        "record_type": "string",
        "record_uuid": "d72e601f-9187-4587-8cc7-767eb01d6038",
        "created_at": "2019-08-24T14:15:22Z",
        "params": {
          "event": "started",
          "title": "The scan Test changed to started",
          "category": "info",
          "event_type": "scan_event"
        },
        "updated_at": "2019-08-24T14:15:22Z",
        "read_at": "2019-08-24T14:15:22Z",
        "seen_at": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "meta": {}
}
🟠401Unauthorized
Modified at 2024-11-12 10:01:31
Previous
List of most vulnerable hosts
Next
Show a notification
Built with