Skip to main content
urlscan.io logo
  • Category: security & identity tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 51
  • Triggers: 0
  • Slug: URLSCANIO
  • Version: 20261101_00

Tools

Slug: URLSCANIO_CLOSE_INCIDENTStop ongoing scans for an active urlscan Pro incident and transition it to the closed state. Closing does not delete the incident or its history, and the incident can later be restarted.

Input Parameters

string
required
Unique _id of the active incident to stop and close.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_COPY_INCIDENTCreate a separate urlscan Pro incident from an existing incident’s configuration. This create operation can consume incident capacity and does not copy the source incident’s stored state history; use the distinct fork operation when history must be preserved. The provider does not document whether the copied incident immediately activates ongoing scans or alerts.

Input Parameters

string
required
Unique _id of the source incident whose configuration is copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_CREATE_CHANNELCreate a Pro notification channel. This operation configures external effects: active webhook channels send requests to the supplied secret URL, and active email channels send messages to the supplied recipients. Confirm the destination and activation settings before calling.

Input Parameters

string
required
Human-readable channel name.
string ("webhook" | "email")
required
Channel delivery type. Select webhook or email.
string
Scheduled UTC delivery time in 24-hour HH:MM format.
string ("live" | "hourly" | "daily")
Notification delivery frequency.
boolean
Whether the channel is active. An active channel can send external webhook or email notifications.
array
Delivery weekdays.
boolean
Whether this is the account’s default notification channel.
boolean
Whether to ignore scheduled delivery timing.
array
Optional team sharing permissions for the channel.
string
Secret HTTP(S) destination for a webhook channel. It may contain an embedded access token and will receive external notifications.
array
External recipients for an email channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_CREATE_INCIDENTCreate a Pro incident that persistently monitors an observable. This high-impact operation starts ongoing external scans and can send alerts through every supplied notification channel; confirm the observable, visibility, channels, cadence, and expiration settings before calling. The operation is contract-only because the connected build account lacks the urlscan Pro Incidents entitlement.

Input Parameters

array
required
Notification channel IDs that receive alerts from this incident. Calling the tool can cause ongoing external email or webhook delivery.
array
Scanner countries used for recurring incident scans.
string
Optional path appended to hostname-type incident scans.
string
required
URL, hostname, or other provider-supported observable to monitor with ongoing scans. Accepted forms are not enumerated by the operation contract.
string ("unlisted" | "private")
required
Visibility assigned to scans created by this incident.
array
User agents used for recurring incident scans.
integer
Interval between ongoing scans; the operation contract does not specify the unit.
object
Optional provider runtime controls for scan rotation, stop delays, post-state intervals, incident profile, and expiration.
string ("manual" | "automatic")
Whether the scan interval is controlled manually or automatically.
array
Observable changes that create incident states and may trigger alerts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_CREATE_LIVE_SCAN_BLOCKINGRun a temporary Live Scan synchronously and return only after the provider finishes the scan. This requires the separate Live Scanning product.

Input Parameters

object
required
Required Live Scan task settings sent under the provider’s task object.
object
Optional execution settings sent under the provider’s scanner object.
string
required
Scanner identifier returned by LIST_LIVE_SCANNERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_CREATE_LIVE_SCAN_TASKStart a non-blocking temporary Live Scan on a selected scanner and return its UUID immediately without waiting for completion. This external scan side effect requires the separate urlscan.io Live Scanning entitlement; a generic Pro plan may not include it.

Input Parameters

string
required
URL to scan asynchronously.
array
Up to 10 user-defined tags, each no longer than 30 characters.
object
Optional timing, request-header, and feature settings for the live scanner.
string
required
Live scanner identifier returned by LIST_LIVE_SCANNERS.
string ("public" | "unlisted" | "private")
Visibility to assign to the temporary Live Scan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_CREATE_SAVED_SEARCHCreate a reusable scans or hostnames search definition. This operation creates a persistent saved search and requires urlscan Pro; the hostnames datasource may require an additional product entitlement.

Input Parameters

string ("red" | "amber+strict" | "amber" | "green" | "clear")
Optional Traffic Light Protocol marking for other urlscan Pro users.
string
required
Human-readable name for the saved search.
string
required
urlscan.io Search API query-string expression.
array
Optional tags applied to matching items. Prefix tags with pro., public., private., or team. to select their visibility scope.
string ("hostnames" | "scans")
required
Datasource queried by this saved search. Hostnames requires its Pro product.
string
Optional short description of the saved search.
array
Optional team or public sharing permissions for the saved search.
string
Optional detailed description of the saved search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_CREATE_SUBSCRIPTIONCreate a persistent scheduled or live alert subscription for saved searches. This Pro-only operation has external notification side effects: an active subscription can send email, invoke configured channels or webhooks, and create incidents. Confirm all recipients and channel or incident settings before calling.

Input Parameters

string
required
Human-readable subscription name.
string ("live" | "hourly" | "daily")
required
How often the subscription evaluates and delivers matching results.
boolean
required
Whether delivery is active. When true, creation may cause external email, channel, webhook, or incident notifications.
array
Optional provider weekday selection.
array
required
Saved-search IDs monitored by the subscription.
array
Notification channel IDs to invoke externally when matching results are delivered.
string
Optional subscription description.
boolean
required
Whether the subscription ignores provider timing constraints.
array
Optional subscription sharing permissions.
array
required
External email recipients for subscription notifications. The provider requires this field even when notification channels are configured.
object
Optional incident notification settings. These fields can cause external incident creation when the active subscription matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_DELETE_RESULTPermanently delete a scan owned by the connected user or team. This destructive operation cannot be reversed and requires urlscan Pro.

Input Parameters

string
required
Owned scan UUID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_DELETE_SAVED_SEARCHPermanently delete a saved search by ID. This destructive operation cannot be undone and requires urlscan Pro saved-search access plus ownership or team write permission. Use it only for a saved search created or explicitly selected by the current workflow.

Input Parameters

string
required
Saved-search ID to permanently delete. Only delete a saved search created or explicitly selected by the current workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_DELETE_SUBSCRIPTIONPermanently delete an alert subscription by ID. This destructive operation cannot be undone and requires urlscan Pro subscriptions access plus ownership or team write permission. Use it only for a subscription created or explicitly selected by the current workflow.

Input Parameters

string
required
Alert subscription ID to permanently delete. Only delete a subscription created or explicitly selected by the current workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_DOWNLOAD_FILERetrieve a captured binary file by its SHA-256 hash as a password-encrypted ZIP archive. This operation requires urlscan Pro access.

Input Parameters

string
Filename for the returned ZIP archive. Defaults to <file_hash>.zip.
string
Password used to encrypt the returned ZIP archive. Defaults to urlscan!.
string
required
SHA-256 hash of the captured binary file to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_FORK_INCIDENTCreate a new Pro incident by copying an existing incident’s configuration and complete stored state history. This creates a separate persistent incident; history volume and whether monitoring starts immediately are not documented.

Input Parameters

string
required
Source incident _id whose configuration and complete stored state history are copied into a new incident.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_ACCOUNT_CAPABILITIESGet non-sensitive plan, product, feature, visibility, submission, and limit information for the connected urlscan.io API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_BRAND_SUMMARYReturn detectable brands with detected-page totals and latest hits. This operation requires urlscan Pro access and uses the official contract only; the provider does not document its response fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_CHANNELGet one urlscan Pro notification channel by ID, preserving provider-specific metadata while filtering recognized webhook destination and credential keys.

Input Parameters

string
required
Unique _id of the notification channel to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_DOMReturn the plain-text DOM snapshot captured for a completed scan.

Input Parameters

string
required
Completed scan UUID from SUBMIT_SCAN or SEARCH_SCANS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_HOSTNAME_HISTORYReturn one page of historical Pro Hostnames observations for a hostname.

Input Parameters

integer
Observations to return in this page (10-10000).
string
required
Hostname to inspect, without a URL path.
string
Opaque pageState returned by a previous GET_HOSTNAME_HISTORY call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_INCIDENTGet one incident’s configuration, source, runtime state, and timestamps.

Input Parameters

string
required
Unique _id of the incident to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_INCIDENT_STATESRetrieve the stored state history for an incident.

Input Parameters

string
required
Incident _id whose stored state history should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_LIVE_SCAN_RESOURCERetrieve a temporary result, DOM, screenshot, captured response, or download from the separate urlscan.io Live Scanning product. Results are returned as JSON and DOM as text; screenshots, captured responses, and downloads are offloaded as downloadable files.

Input Parameters

string
required
Live scanner identifier from LIST_LIVE_SCANNERS. Live Scanning is a separate urlscan.io product.
string
required
Scan UUID for result, screenshot, or dom; SHA-256 resource hash for response or download. Temporary Live Scan resources typically expire about 60 minutes after creation.
string ("result" | "screenshot" | "dom" | "response" | "download")
required
Resource kind: result returns JSON, dom returns text, screenshot and download return files, and response follows its captured media type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_PHISHFEEDRetrieve the deprecated urlscan Pro phishing feed in JSON, CSV, or TSV. Prefer SEARCH_SCANS for new workflows, as recommended by urlscan.io.

Input Parameters

integer
Maximum number of feed records to return. urlscan.io does not document bounds for this deprecated endpoint.
string
Optional urlscan.io query-string filter for detected phishing pages.
string ("csv" | "tsv" | "json")
Response representation: json returns structured search results, while csv and tsv return delimited text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_QUOTASGet current products, features, query capabilities, and per-action minute, hour, and day quota usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_RESPONSE_CONTENTReturn textual content captured in a scan response, addressed by its SHA-256 hash.

Input Parameters

string
required
SHA-256 response hash from GET_RESULT data.requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_RESULTRetrieve the complete metadata and captured request data for a completed scan UUID.

Input Parameters

string
required
Scan UUID from SUBMIT_SCAN or SEARCH_SCANS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_SAVED_SEARCH_RESULTSRun a urlscan Pro saved search and return its current Search API results. The provider redirect is followed automatically; this operation does not expose pagination controls.

Input Parameters

string
required
Unique ID of the saved search to run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_SCREENSHOTRetrieve a completed urlscan.io scan screenshot as a downloadable PNG file reference.

Input Parameters

string
required
Completed scan UUID from Submit Scan or Search Scans.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_SIMILAR_RESULTSFind one page of scan results structurally similar to a specified scan. Requires urlscan Pro access.

Input Parameters

integer
Maximum results in this page. urlscan.io does not document an operation-specific upper bound for this Pro endpoint.
string
Optional urlscan.io query-string expression used to filter similar results.
string
required
Reference scan UUID whose structural similarity is evaluated.
string
Opaque continuation returned by a previous GET_SIMILAR_RESULTS call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_GET_SUBSCRIPTION_RESULTSResolve a urlscan Pro alert subscription and datasource to its current Search API results. The provider redirect is followed automatically; this operation does not expose pagination controls.

Input Parameters

string
required
Datasource configured for the subscription. The provider does not publish an exhaustive list of accepted values for this operation.
string
required
Unique _id of the alert subscription to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_AVAILABLE_BRANDSList brand identifiers and metadata tracked by urlscan.io brand and phishing detection. Requires urlscan Pro brand/phishing access; the exact product and minimum plan are not documented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_AVAILABLE_COUNTRIESList scanner country codes currently accepted by the Scan API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_CHANNELSList email and webhook notification channels for the current user, filtering recognized webhook URL and credential keys. This operation requires urlscan Pro channels access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_DATA_DUMPSList available urlscan.io data-dump files for a time window, file type, and date. Requires an Enterprise or Ultimate plan; availability can vary by window and file type.

Input Parameters

string
required
Calendar date in YYYYMMDD format.
string ("api" | "search" | "screenshot" | "dom")
required
Dump content family: api, search, screenshot, or dom.
string ("days" | "hours" | "minutes")
required
Dump aggregation window: days, hours, or minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_LIVE_SCANNERSList Live Scanning nodes available to the connected account and their current metadata. This requires the separate urlscan.io Live Scanning product; a generic urlscan Pro plan may not include it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_SAVED_SEARCHESList saved searches owned by or shared with the current user. This operation requires urlscan Pro saved-search access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_SUBSCRIPTIONSList alert subscriptions configured for the current user. This operation requires urlscan Pro subscriptions access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_USER_AGENTSList grouped browser user-agent strings available for scan submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LIST_WATCHABLE_ATTRIBUTESList attribute values accepted when configuring incident change monitoring. Requires urlscan Pro Incidents capability; the exact minimum plan or product is not documented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_LOOKUP_MALICIOUS_OBSERVABLELook up malicious-scan occurrence counts and first/last seen timestamps for an IP, hostname, domain, or exact URL. Requires urlscan Pro malicious-observable access.

Input Parameters

string ("ip" | "hostname" | "domain" | "url")
required
Observable kind: IP address, exact hostname, apex domain, or exact URL.
string
required
Exact observable value. Provide URLs unencoded; the complete value is safely URL-encoded as one path segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_PURGE_LIVE_SCAN_RESULTPermanently delete a temporary result from the separate urlscan.io Live Scanning product before its normal expiration. This destructive operation cannot be undone; only use it to clean up a temporary result created by the current workflow.

Input Parameters

string
required
UUID of the temporary Live Scan result to permanently purge before its normal expiration. Only purge a result created for the current workflow.
string
required
Live Scanning node identifier returned by LIST_LIVE_SCANNERS. Live Scanning is a separate urlscan.io product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_RESET_RESULT_VISIBILITYRemove an owned scan’s visibility override and restore the visibility originally assigned at submission. This resets an override; it does not delete the scan. Requires urlscan Pro.

Input Parameters

string
required
Owned scan UUID whose visibility override should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_RESTART_INCIDENTRestart a closed urlscan Pro incident and extend its expiry. This resumes ongoing external monitoring, begins recording new incident states, and can resume alerts through the incident’s configured notification channels; confirm the incident should become active again before calling. This operation is contract-only because the connected build account lacks Pro Incidents access.

Input Parameters

string
required
Unique _id of the closed incident to restart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_SEARCH_SCANSSearch urlscan.io data with Elasticsearch Query String syntax and return one controllable page of results.

Input Parameters

integer
Results in this page (1-10000). The connected account may enforce a lower maximum; 1000 was verified for a free account.
string
Provider query-string expression. Results follow urlscan.io semantics and may not strictly match intuitive filtering.
string
Optional provider field used to collapse duplicate results.
string ("scans" | "hostnames" | "incidents" | "notifications" | "certificates")
Datasource to query. Only scans is available without the corresponding urlscan Pro entitlement.
string
Opaque continuation returned by a previous SEARCH_SCANS call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_STORE_LIVE_SCAN_RESULTPermanently store an existing temporary Live Scan result with the selected visibility. This updates the temporary result into a durable snapshot and requires the separate urlscan.io Live Scanning entitlement; a generic urlscan Pro plan may not include it.

Input Parameters

string
required
UUID of the temporary Live Scan result to store permanently.
string
required
Live Scanning node identifier returned by LIST_LIVE_SCANNERS.
string ("public" | "unlisted" | "private")
required
Visibility to apply to the permanently stored scan result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_SUBMIT_SCANSubmit a URL for asynchronous external scanning, creating persistent result state and consuming quota. Visibility defaults to public, and free accounts have no cleanup operation. Returns the scan UUID for result and asset retrieval.

Input Parameters

string
required
URL to scan.
array
Up to 10 tags, each containing 1-30 characters.
string
Lowercase ISO 3166-1 alpha-2 scanner country returned by LIST_AVAILABLE_COUNTRIES.
string
Optional Referer value for the scanned navigation.
string ("public" | "unlisted" | "private")
Who can discover the scan. The connected account may permit fewer visibility values.
string
Custom browser user-agent string for the scan.
string
Any non-empty value disables automatic PII visibility reclassification. Use only when the caller understands the exposure risk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_UPDATE_CHANNELReplace the complete configuration of an existing Pro notification channel. This operation can redirect external effects: active webhook channels send requests to the supplied secret URL, and active email channels send messages to the supplied recipients. Confirm the complete destination and activation settings before calling.

Input Parameters

string
required
Complete human-readable channel name required by this PUT operation.
string ("webhook" | "email")
required
Complete channel delivery type required by this PUT operation.
string
Replacement scheduled UTC delivery time in 24-hour HH:MM format.
string ("live" | "hourly" | "daily")
Replacement notification delivery frequency.
boolean
Replacement active state. Setting this to true can send external webhook requests or email notifications.
array
Replacement delivery weekdays.
string
required
Unique ID of the notification channel to replace.
boolean
Whether this becomes the account’s default notification channel.
boolean
Whether the replacement ignores scheduled delivery timing.
array
Replacement team sharing permissions for the channel.
string
Secret HTTP(S) destination required for a webhook channel. It may contain an embedded access token and will receive external notifications.
array
Complete external recipient list required for an email channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_UPDATE_INCIDENTReplace an existing incident’s monitoring configuration and runtime options. This Pro-only PUT requires observable, visibility, and the complete channel set, not only changed values. Updating it changes ongoing external scanning and can redirect or trigger future channel alerts; confirm the complete replacement configuration before calling.

Input Parameters

array
required
Complete notification channel ID set. Replacing it changes where future incident alerts are delivered.
array
Optional ISO 3166-1 country codes from which incident scans run.
string
Optional path appended to hostname-type incident scans.
string
required
Complete hostname, domain, IP address, or URL to monitor. Changing it redirects the incident’s ongoing scans.
string ("unlisted" | "private")
required
Complete visibility for scans created by this incident.
string
required
Unique ID of the incident whose complete monitoring configuration is replaced.
array
Optional browser user agents used for the incident’s ongoing scans.
integer
Optional interval in seconds between full website scans.
object
Optional replacement timing, distribution, profile, and expiry settings. Keys use the provider’s documented spellings.
string ("manual" | "automatic")
Optional interval control mode. In manual mode, post-suspension and post-malicious interval settings have no effect.
array
Optional incident attributes whose changes create monitored states and alerts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_UPDATE_RESULT_VISIBILITYChange the visibility of a scan owned by the connected user or team. This operation requires a paid urlscan Pro entitlement and is contract-only, not live verified. Use DELETE_RESULT for permanent deletion.

Input Parameters

string
required
Owned scan UUID whose visibility should be changed.
string ("public" | "unlisted" | "private")
required
New public, unlisted, or private visibility for the scan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_UPDATE_SAVED_SEARCHReplace the complete definition and metadata of an existing saved search. This PUT operation requires urlscan Pro saved-search access and write permission; the hostnames datasource may require an additional entitlement.

Input Parameters

string ("red" | "amber+strict" | "amber" | "green" | "clear")
Optional replacement Traffic Light Protocol marking.
string
required
Complete human-readable name required by the replacement operation.
string
required
Complete urlscan.io Search API query required by the replacement operation.
string
required
Unique ID of the saved search to replace.
array
Optional replacement user-defined tags applied to matching items.
string ("hostnames" | "scans")
required
Complete datasource value required by the replacement operation.
string
Optional replacement short description.
array
Optional replacement team or public sharing permissions.
string
Optional replacement detailed description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: URLSCANIO_UPDATE_SUBSCRIPTIONReplace the complete configuration of an existing alert subscription. This Pro-only PUT requires every mandatory field, not only changed values. It has external notification side effects: activating the subscription or changing recipients, channels, webhooks, or incident settings can send notifications or create incidents. Confirm the complete replacement configuration before calling.

Input Parameters

string
required
Complete human-readable subscription name required by this PUT operation.
string ("live" | "hourly" | "daily")
required
Complete evaluation and delivery frequency required by this PUT operation.
boolean
required
Complete active state. Setting this to true can cause external email, channel, webhook, or incident notifications.
array
Optional replacement weekday selection.
array
required
Complete saved-search ID set monitored by the replacement subscription.
array
Replacement notification channel IDs to invoke externally when matching results are delivered.
string
Optional replacement subscription description.
boolean
required
Complete setting for whether the subscription ignores provider timing constraints.
array
Optional replacement subscription sharing permissions.
array
required
Complete external email recipient list for subscription notifications. Changing this list can redirect future notifications.
string
required
Unique ID of the alert subscription to replace.
object
Optional replacement incident notification settings. Changing these fields can cause external incident creation when the active subscription matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not