CG Scanning API V2
5.2.0
  • latest
  • 5.2.0
HomeDocs
HomeDocs
5.2.0
  • latest
  • 5.2.0
  1. Targets
  • Common Error Responses
  • Authentication
  • Filtering Data
  • Getting Started
  • 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
  • Advanced Reports
    • 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
  • Audit
    • Get all events
      GET
    • Get event by id
      GET
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • Targets
    • List targets
      GET
    • Create Target
      POST
    • Show a target
      GET
    • Updates a target
      PUT
    • Delete a target
      DELETE
    • Delete targets
      DELETE
  • 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
  • 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
  • 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
  • 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
  1. Targets

Updates a target

PUT
/v2/targets/{id}
Targets
Last modified:2025-04-24 10:59:46
Update an existing target.

Request

Path Params
id
string 
required
Body Params application/json
target
object 
required
name
string 
optional
Target Name
Example:
target test
hosts
string 
optional
Enter the IP Address or IP range for your network
hosts (Ex: An IP: 192.168.1.1 or a range of IPs: 192.168.1.0/24)
Example:
155.168.1.0/24
exclude_hosts
string  | null 
optional
Excluded Hosts
Example:
155.168.1.55
credentials
object 
optional
port_list_id
<uuid>
optional
Port list id
alive_test
enum<string> 
optional
Alive test
Allowed values:
scan_config_defaulticmptcp_synconsider_alive
comment
string  | null 
optional
Target Description
Example:
my comment
Example
{
  "target": {
    "name": "target test",
    "hosts": "155.168.1.0/24",
    "exclude_hosts": "155.168.1.55",
    "credentials": {
      "ssh": "3d93f13d-fe75-4d5f-a6f9-7916c56a46ca",
      "smb": "3d43fe94-3c23-49d9-b61b-62a6b516a841",
      "esxi": "5018e745-21f4-42fd-a757-dccd5220f062",
      "snmp": "f60cef17-b24e-472e-8868-db35d7a5e896"
    },
    "port_list_id": null,
    "alive_test": "scan_config_default",
    "comment": "my comment"
  }
}

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 PUT '/v2/targets/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "target": {
        "name": "target test",
        "hosts": "155.168.1.0/24",
        "exclude_hosts": "155.168.1.55",
        "credentials": {
            "ssh": "3d93f13d-fe75-4d5f-a6f9-7916c56a46ca",
            "smb": "3d43fe94-3c23-49d9-b61b-62a6b516a841",
            "esxi": "5018e745-21f4-42fd-a757-dccd5220f062",
            "snmp": "f60cef17-b24e-472e-8868-db35d7a5e896"
        },
        "port_list_id": null,
        "alive_test": "scan_config_default",
        "comment": "my comment"
    }
}'

Responses

🟢200OK
application/json
Target updated
Body
data
optional
One of
id
string <uuid>
optional
name
string 
optional
hosts
string 
optional
exclude_hosts
string  | null 
optional
comment
string  | null 
optional
Example
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "hosts": "string",
    "exclude_hosts": "string",
    "comment": "string"
  }
}
🟠401Unauthorized
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-04-24 10:59:46
Previous
Show a target
Next
Delete a target
Built with