1. Scanning API
CG Scanning API V2
5.5.x
  • latest
  • 5.4.2
  • 5.5.x
  • Scanning API
    • Getting Started
    • Authentication
    • Common Error Responses
    • Filtering Data
    • Core Workflows
    • 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
      • Calculate Hosts
    • 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
      • 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
      • Verifies file integrity by comparing hashes
    • Vulnerabilities
      • List of vulnerabilities
      • Vulnerability details
      • Total Vulnerabilities (widget)
      • Top Vulnerabilities (widget)
      • PCI Compliant (widget)
    • 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
    • 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
    • Credentials
      • List Credentials
      • Show Credential
      • Delete Credential
      • Create Credential
      • Update Credential
    • 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
    • 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
    • Whitelabel Settings
      • Show the white label settings
      • Show the white label settings
      • Update white label settings
    • 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
    • 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
    • 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
      • Transfers all the resources from the user to another user
    • 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
    • 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
    • Schemas
      • Schemas
        • vulnerabilityData
        • SingleResponseBase
        • CollectionResponseBase
        • TargetResource
        • TargetResponse
        • TargetAttributes
        • TargetsListResponse
        • errors_map
        • OwnerAttributes
        • FeaturesBodyRequest
        • errorObject
        • ErrorResponse
        • not_found
        • forbidden
        • unauthorized
        • unprocessable_entity
        • pagination
        • meta
        • target
        • scan
        • product
        • productsResponse
  • SAQ API
    • List all SAQs
      GET
    • List Available SAQ Types
      GET
    • Get SAQ Type Template
      GET
    • Get SAQ (JSON) or Download SAQ (PDF)
      GET
    • Create a New SAQ
      POST
    • Delete an SAQ
      DELETE
    • Clone an SAQ
      PUT
    • Approve an SAQ
      PUT
    • Set SAQ as a template
      PUT
Home
DocsPurchase PCI ASV Certified Scan
Home
DocsPurchase PCI ASV Certified Scan
5.5.x
  • latest
  • 5.4.2
  • 5.5.x
  1. Scanning API

Getting Started

Clone Systems Scan API Documentation#

API Version: 5.5.1
Scanning Solution Doc: scanning-docs.clone-systems.com
The Clone Systems Security Scanning API allows you to integrate your applications with the Clone Guard® platform to manage organizations, users and security scans programmatically.
This API is available to customers and partners with an active subscription to Clone Guard® Security Scanning services.

Getting Started#

To start using the API, you will typically follow a simple workflow:
1
Create an Organization
Create a new organization to represent your customer or internal entity.
This acts as the main container for users, targets, and scans.
2
Create or Invite a User
Add users to the organization or send invitations.
Users will be able to access the portal and manage scans, targets, and reports.
3
Create & run a Scan
Define a target (IPs, domains, or networks) and start a scan using the appropriate product and scan configurations.
This step performs the actual security assessment of the specified assets.
4
Generate and Download the Report
Once the scan is completed, generate a report and download it.
Reports include findings, vulnerabilities, and insights depending on the selected product.
Each step is performed via dedicated API endpoints and represents the core flow of the platform.
👉 You can explore this flow in detail in the Core Workflows section.

Available Products#

PCI ASV Scanning
PCI Compliance Scanning allows organizations to comply with PCI SSC and safeguard customer data.
Vulnerability Scanning
Vulnerability Assessment helps you evaluate your infrastructure’s security to identify vulnerabilities and obtain recommendations to improve security.
Penetration Testing
Keep your Business safe from Cyber Threats with our Continuous Penetration Testing Solution.

Modules#

SAQ (Self-Assessment Questionnaire)
PCI ASV users can complete their Self-Assessment Questionnaire (SAQ) through the SAQ Wizard and guided forms within the platform.
Partners can also integrate SAQ functionality via the API to create, manage, and track SAQs programmatically.
What's Next?
Now that you’re familiar with the basics of our API, the next step is to learn how to authenticate your requests.
Modified at 2026-03-26 16:46:51
Next
Authentication
Built with