> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/urlscan.io.md).

# urlscan.io

Submit unlisted website scans, inspect results, search historical scans, and download captured screenshots or DOM snapshots.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| urlscan.io | API Key        |

### urlscan.io

Connect to urlscan.io to submit unlisted website scans, retrieve results, search historical scans, and download screenshots or DOM snapshots.

#### Set up in urlscan.io

1. Prepare the urlscan.io account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your API key from the urlscan.io profile page.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **urlscan.io**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                             |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your API key from the urlscan.io profile page. [Provider instructions](https://urlscan.io/user/profile/). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **urlscan.io** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Submit URL for Scanning

Submit a website to urlscan.io for an unlisted security scan.

#### Inputs

| Field | Type   | Required | Description                        |
| ----- | ------ | -------- | ---------------------------------- |
| URL   | string | Yes      | The HTTP or HTTPS website to scan. |

#### Outputs

| Field      | Type   | Description                             |
| ---------- | ------ | --------------------------------------- |
| Scan ID    | string | The new scan UUID.                      |
| Result URL | string | The human-readable scan report URL.     |
| API URL    | string | The scan result API URL.                |
| Message    | string | The submission status message.          |
| Visibility | string | The scan visibility, fixed to unlisted. |

### Get Scan Result

Retrieve the complete result for a finished urlscan.io scan.

#### Inputs

| Field   | Type   | Required | Description                |
| ------- | ------ | -------- | -------------------------- |
| Scan ID | string | Yes      | The scan UUID to retrieve. |

#### Outputs

| Field         | Type    | Description                         |
| ------------- | ------- | ----------------------------------- |
| Result        | dict    | The full urlscan.io result object.  |
| Scan ID       | string  | The scan UUID.                      |
| Submitted URL | string  | The URL originally submitted.       |
| Scanned URL   | string  | The final page URL after redirects. |
| Page Title    | string  | The scanned page title.             |
| Status Code   | integer | The primary page HTTP status code.  |

### Search Scans

Search recent urlscan.io scans with its query syntax.

#### Inputs

| Field       | Type    | Required | Description                                                       |
| ----------- | ------- | -------- | ----------------------------------------------------------------- |
| Query       | string  | Yes      | A urlscan.io search query, preferably with a date range.          |
| Max Results | integer | No       | Maximum scans to return, from 1 to 100. Minimum: 1. Maximum: 100. |
| Cursor      | string  | No       | Optional cursor from a previous search response.                  |

#### Outputs

| Field       | Type          | Description                                   |
| ----------- | ------------- | --------------------------------------------- |
| Results     | object\_array | Matching scan summaries.                      |
| Count       | integer       | Number of scan summaries returned.            |
| Next Cursor | string        | Cursor for the next older page, if available. |

### Get Scan Screenshot

Download the PNG screenshot captured for a scan.

#### Inputs

| Field   | Type   | Required | Description                                 |
| ------- | ------ | -------- | ------------------------------------------- |
| Scan ID | string | Yes      | The scan UUID whose screenshot to download. |

#### Outputs

| Field             | Type    | Description                             |
| ----------------- | ------- | --------------------------------------- |
| Screenshot Base64 | string  | Base64-encoded PNG screenshot content.  |
| Media Type        | string  | The screenshot media type.              |
| Size in Bytes     | integer | Downloaded PNG size in bytes.           |
| Screenshot URL    | string  | The urlscan.io screenshot endpoint URL. |

### Get Scan DOM Snapshot

Download the captured DOM snapshot for a scan.

#### Inputs

| Field   | Type   | Required | Description                                   |
| ------- | ------ | -------- | --------------------------------------------- |
| Scan ID | string | Yes      | The scan UUID whose DOM snapshot to download. |

#### Outputs

| Field         | Type     | Description                      |
| ------------- | -------- | -------------------------------- |
| DOM Snapshot  | textarea | The captured page DOM as text.   |
| Size in Bytes | integer  | Downloaded DOM size in bytes.    |
| DOM URL       | string   | The urlscan.io DOM endpoint URL. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/urlscan.io.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
