Skip to main content

Cyware Orchestrate

Action: Create a Scan

This action creates a scan for an asset or IP address or both.

Input Parameters

Parameters

Description

Field Type

Required/Optional

Comments

Scan Name

Enter the scan name to create a new scan.

Example:

Full Access

Text

Required

Description

Enter a description.

Example:

Full Access Group

Text

Required

Policy ID

Enter the policy ID.

Example:

1002331

Text

Required

Repository ID

Enter the repository ID.

Example:

1234

Text

Required

IP Address

Enter the IP addresses.

Example:

10.0.0.1

Text

Optional

You can enter the IP address or assets or even both.

Asset ID

Enter the Asset ID.

Example:

0001

Text

Optional

You can enter IP address or asset or even both.

Credential ID

Enter the credential ID.

Example:

1000024

Text

Optional

Maximum Scan Time

Enter the maximum time for the scan in hours.

Example:

6

Text

Optional

By default, the time is set to unlimited.

Zone ID

Enter the zone ID.

Example:

-1

Text

Optional

By default, the value is set to 0.

Extra Params

Enter the extra parameters.

Example:

"createdTime"

Key-value

Optional

Allowed values:

  • createdTime

  • modifiedTime

  • reports

Example Request

[
  {
    "assets": "756",
    "zone_id": "-1",
    "policy_id": "1000116",
    "scan_name": "test-1",
    "description": "test-1",
    "extra_param": {},
    "repository_id": "3"
  }
]