Cyware Orchestrate

Get Index Details 

This action retrieves a paginated list of all documents from the index of your choice. By default, a maximum of 100 documents are shown per page.

Get Vulnerabilities with CPE 

This action retrieves all vulnerabilities related to a CPE.

Get Vulnerability with PURL 

This action retrieves all vulnerabilities related to a PURL.

List Indexes 

This action returns a list of indexes with backup and endpoint links.

Generic Action 

This is a generic action used to make requests to any VulnCheck endpoint.

API Token 

Enter the API token to authenticate with VulnCheck.

Password

Required

API Version 

Enter the API version of VulnCheck. 

Text

Optional

Default value:

v3

Timeout 

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with VulnCheck.

Integer

Optional

Allowed Range:

15-120

Default value:

15

Verify 

Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. 

Boolean

Optional

Default value:

false

Index Name 

Enter the index name to get the details. 

Example: 

vulncheck-nvd2

Text

Required

CVE ID 

Enter the CVE ID to get the details. 

Example: 

cve-2019-0708

Text

Optional

Allowed Format:

(CVE-YYYY-N{4-7})

Alias 

Enter the alias to get the details. 

Example: 

ms17-010

Text

Optional

MISP ID 

Enter the MISP ID to get the details. 

Example: 

1

Text

Optional

Publication Start Date 

Enter the publication start date to retrieve the details.

Example:

2021-01-01

Text

Optional

Allowed Format:

YYYY-MM-DD

Publication End Date 

Enter the publication end date to retrieve the details. 

Example:

2021-12-31

Text

Optional

Allowed Format:

YYYY-MM-DD

Additional Data 

Enter the additional parameters to pass to the API. 

Example: 

{"page": 1, "size": 10}

Key Value

Optional

{app_instance} 

JSON Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.response 

JSON Object

Includes the response received from the app action.

app_instance.response.data 

Array of JSON Objects

Returns a list of indexes.

app_instance.response.data.description 

String

Returns the description of the index.

app_instance.response.data.href 

Array

Returns the VulnCheck link to the index.

app_instance.response.data.name 

JSON Object

Returns the name of the index.

CPE ID 

Enter the CPE ID to get the related vulnerabilities. 

Example: 

cpe:/a:microsoft:internet_explorer:8.0.6001:beta

Text

Required

{app_instance} 

JSON Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.response 

JSON Object

Includes the response received from the app action.

app_instance.response._meta 

JSON Object

Returns the metadata of the input CPE ID.

app_instance.response._meta.cpe 

String

Returns the CPE ID.

app_instance.response._meta.cpe_struct 

JSON Object

Returns the construct of the CPE ID, such as the part, vendor, product, version, update, edition, language, sw_edition, target_sw, target_hw, and other.

app_instance.response._meta.timestamp 

String

Returns the timestamp of the request.

app_instance.response._meta.total_documents

Integer

Returns the total number of vulnerabilities related to the CPE ID.

app_instance.response.data

Array

Returns a list of CVE IDs related to the CPE ID.

PURL ID 

Enter the PURL ID to get the related vulnerabilities. 

Example: 

pkg:hex/coherence@0.1.2

Text

Required

Refer VulnCheck API documentation for supported package managers.

app_instance/_benchmark

Float

The benchmark value indicating performance, e.g., 0.057389

app_instance/_meta/purl_struct/type

String

The type of the package URL, e.g., 'hex'

app_instance/_meta/purl_struct/namespace

String

The namespace of the package URL, e.g., ''

app_instance/_meta/purl_struct/name

String

The name of the package, e.g., 'coherence'

app_instance/_meta/purl_struct/version

String

The version of the package, e.g., '0.1.2'

app_instance/_meta/purl_struct/qualifiers

Null

The qualifiers of the package URL, which is null

app_instance/_meta/purl_struct/subpath

String

The sub-path of the package URL, e.g., ''

app_instance/_meta/timestamp

String

The timestamp of the metadata, e.g., '2023-09-11T15:02:50.325502302Z'

app_instance/_meta/total_documents

Integer

The total number of documents, e.g., 1

app_instance/data/cves

Array of Strings

The array of CVE identifiers, e.g., ['CVE-2018-20301']

app_instance/data/vulnerabilities/detection

String

The detection identifier, e.g., 'CVE-2018-20301'

app_instance/data/vulnerabilities/fixed_version

String

The version in which the vulnerability is fixed, e.g., '0.5.2'

app_instance/_benchmark

Float

The benchmark value indicating performance, e.g., 1.146941

app_instance/data/count

Integer

The total count of items, e.g., 102

app_instance/data/indexes/name

String

The name of the index, e.g., 'abb'

app_instance/data/indexes/description

String

The description of the index, e.g., 'ABB Vulnerabilities'

app_instance/data/indexes/endpoint

URL

The API endpoint for the index, e.g., 'https://api.vulncheck.com/v3/index/abb'

Method 

Enter the HTTP method to make the request. 

Text

Required

Allowed values:

Endpoint 

Enter the endpoint to make the request. 

Example: 

/v3/vulncheck/indexes

Text

Required

Query Params 

Enter the query parameters to pass to the API. 

Example: 

{"page": 1, "size": 10}

Key Value

Optional

Payload 

Enter the payload to pass to the API. 

Example: 

{"name": "test"}

Any

Optional

Extra Fields 

Enter the extra fields to pass to the API.

Key Value

Optional