Skip to main content

urlscan.io 1.0.0

App Vendor: URL Scan

App Category: Data Enrichment & Threat Intelligence

Connector Version: 1.0.0

API Version: 1.0.0

About App

The URL Scan app provides integration with the URL Scan application. The urlscan.io is a service which analyses websites and the resources they request. The URL scan helps in assisting even inexperienced users to take a look at what a particular website is requesting in the background.

The URL Scan app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Global Query Search

This action performs a global query search in the URL Scan application.

Get Scan Result

This action retrieves the results of a scan from the URL Scan application.

Submit URL for Scan

This action submits a URL (FQDN, URL) for scanning in the URL Scan application.

Configuration Parameters

The following configuration parameters are required for the URL Scan app to communicate with the URL Scan enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

API Key

Enter the API key.

Text

Required

Action: Global Query Search

This action performs a global query search in the URL Scan application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query String

Enter the query string. The default value is '*'.

Text

Optional

Size

Enter the result size. The default value is 100.

Integer

Optional

Offset

Enter the first page offset. The default value is 0.

Integer

Optional

Default value:

0

Sorting

Enter the sorting value.

Text

Optional

Example Request

[
    {
        "query": “*”,
        "size": 100
    }
]

Action: Get scan result

This action retrieves the results of a scan from the URL Scan application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Scan ID

Enter the scan ID.

Example:

"scanID101"

Text

Required

Example Request

[
    {
        "scan_id": "scanID101"
    }
]

Action: Submit URL for Scan

This action submits a URL (FQDN, URI) for scanning in the URL Scan application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

FQDN

Enter the FQDN.

Example:

"www.google.com"

Text

Required

Allowed values:

  • URL

  • Domain

Scan Type

Enter the scan type.

Example:

"off"

Text

Optional

Allowed values:

  • off(default): for private scan

  • on: for public scan

Extra Params

Enter any additional parameters.

Key Value

Optional

Allowed values:

  • tags: list of tags, comma separated (max 10)

  • referer: Override HTTP referer for this scan.

  • customagent: Override User-Agent for this scan.

Example Request

[
    {
         "fqdn": "cyware.com",
         "scan_type": "off",
         "params":
         {
              "tags": ["demotag1", "demotag2"]
         }
    }
]