data
urlscan.io MCP, CLI, and Lua Integration for AI Agents
urlscan.io integration docs for AI agents: MCP gateway setup, urlscan.io CLI commands, Lua API reference, credentials, and function schemas.urlscan.io for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
urlscan.urlscan_submit_scan | Write write | 1 | Scan Official urlscan.io endpoint: POST /api/v1/scan. |
urlscan.urlscan_search_datasource | Read read | 5 | Search Official urlscan.io endpoint: GET /api/v1/search. |
urlscan.urlscan_get_result | Read read | 1 | Result Official urlscan.io endpoint: GET /api/v1/result/{scanId}/. |
urlscan.urlscan_get_screenshot | Read read | 1 | Screenshot Official urlscan.io endpoint: GET /screenshots/{scanId}.png. |
urlscan.urlscan_get_dom | Read read | 1 | DOM Official urlscan.io endpoint: GET /dom/{scanId}/. |
urlscan.urlscan_get_response | Read read | 1 | Response Official urlscan.io endpoint: GET /responses/{fileHash}/. |
urlscan.urlscan_update_result_visibility | Write write | 2 | Update Result Visibility Official urlscan.io endpoint: PUT /api/v1/result/{scanId}/visibility/. |
urlscan.urlscan_delete_result_visibility | Write write | 1 | Reset to original visibility Official urlscan.io endpoint: DELETE /api/v1/result/{scanId}/visibility/. |
urlscan.urlscan_get_available_countries | Read read | 0 | Available Countries Official urlscan.io endpoint: GET /api/v1/availableCountries. |
urlscan.urlscan_get_user_agents | Read read | 0 | Available User Agents Official urlscan.io endpoint: GET /api/v1/userAgents. |
urlscan.urlscan_get_quotas | Read read | 0 | API Quotas Official urlscan.io endpoint: GET /api/v1/quotas. |
urlscan.urlscan_get_available_brands | Read read | 0 | Available Brands Official urlscan.io endpoint: GET /api/v1/pro/availableBrands. |
urlscan.urlscan_get_brand_summary | Read read | 0 | Brands Official urlscan.io endpoint: GET /api/v1/pro/brands. |
urlscan.urlscan_get_phishfeed | Read read | 3 | Phishfeed Official urlscan.io endpoint: GET /api/v1/pro/phishfeed. |
urlscan.urlscan_get_livescan_scanners | Read read | 0 | Live Scanners Official urlscan.io endpoint: GET /api/v1/livescan/scanners/. |
urlscan.urlscan_create_livescan_task | Write write | 2 | Non-Blocking Trigger Live Scan Official urlscan.io endpoint: POST /api/v1/livescan/{scannerId}/task/. |
urlscan.urlscan_create_livescan_scan | Write write | 2 | Trigger Live Scan Official urlscan.io endpoint: POST /api/v1/livescan/{scannerId}/scan/. |
urlscan.urlscan_get_livescan_resource | Read read | 3 | Live Scan Get Resource Official urlscan.io endpoint: GET /api/v1/livescan/{scannerId}/{resourceType}/{resourceId}. |
urlscan.urlscan_store_livescan_result | Read read | 3 | Store Live Scan Result Official urlscan.io endpoint: PUT /api/v1/livescan/{scannerId}/{scanId}/. |
urlscan.urlscan_discard_livescan_result | Read read | 2 | Purge Live Scan Result Official urlscan.io endpoint: DELETE /api/v1/livescan/{scannerId}/{scanId}/. |
urlscan.urlscan_get_hostname_history | Read read | 3 | Hostname History Official urlscan.io endpoint: GET /api/v1/hostname/{hostname}. |
urlscan.urlscan_get_pro_username | Read read | 0 | User Information Official urlscan.io endpoint: GET /api/v1/pro/username. |
urlscan.urlscan_get_similar_results | Read read | 4 | Structure Search Official urlscan.io endpoint: GET /api/v1/pro/result/{scanId}/similar/. |
urlscan.urlscan_list_saved_searches | Read read | 0 | Saved Searches Official urlscan.io endpoint: GET /api/v1/user/searches/. |
urlscan.urlscan_create_saved_search | Write write | 1 | Create Saved Search Official urlscan.io endpoint: POST /api/v1/user/searches/. |
urlscan.urlscan_update_saved_search | Write write | 2 | Update Saved Search Official urlscan.io endpoint: PUT /api/v1/user/searches/{searchId}/. |
urlscan.urlscan_delete_saved_search | Write write | 1 | Delete Saved Search Official urlscan.io endpoint: DELETE /api/v1/user/searches/{searchId}/. |
urlscan.urlscan_get_saved_search_results | Read read | 1 | Saved Search Search Results Official urlscan.io endpoint: GET /api/v1/user/searches/{searchId}/results/. |
urlscan.urlscan_list_subscriptions | Read read | 0 | Subscriptions Official urlscan.io endpoint: GET /api/v1/user/subscriptions/. |
urlscan.urlscan_create_subscription | Write write | 1 | Create Subscription Official urlscan.io endpoint: POST /api/v1/user/subscriptions/. |
urlscan.urlscan_update_subscription | Write write | 2 | Update Subscription Official urlscan.io endpoint: PUT /api/v1/user/subscriptions/{subscriptionId}/. |
urlscan.urlscan_delete_subscription | Write write | 1 | Delete Subscription Official urlscan.io endpoint: DELETE /api/v1/user/subscriptions/{subscriptionId}/. |
urlscan.urlscan_get_subscription_results | Read read | 2 | Subscription Search Results Official urlscan.io endpoint: GET /api/v1/user/subscriptions/{subscriptionId}/results/{datasource}/. |
urlscan.urlscan_list_channels | Read read | 0 | Channels Official urlscan.io endpoint: GET /api/v1/user/channels/. |
urlscan.urlscan_create_channel | Write write | 1 | Create Channel Official urlscan.io endpoint: POST /api/v1/user/channels/. |
urlscan.urlscan_get_channel | Read read | 1 | Channel Search Results Official urlscan.io endpoint: GET /api/v1/user/channels/{channelId}. |
urlscan.urlscan_update_channel | Write write | 2 | Update Channel Official urlscan.io endpoint: PUT /api/v1/user/channels/{channelId}. |
urlscan.urlscan_create_incident | Write write | 1 | Create Incident Official urlscan.io endpoint: POST /api/v1/user/incidents. |
urlscan.urlscan_get_incident | Read read | 1 | Get Incident Official urlscan.io endpoint: GET /api/v1/user/incidents/{incidentId}. |
urlscan.urlscan_update_incident | Write write | 2 | Update Incident options Official urlscan.io endpoint: PUT /api/v1/user/incidents/{incidentId}. |
urlscan.urlscan_close_incident | Read read | 2 | Close Incident Official urlscan.io endpoint: PUT /api/v1/user/incidents/{incidentId}/close. |
urlscan.urlscan_restart_incident | Read read | 2 | Restart Incident Official urlscan.io endpoint: PUT /api/v1/user/incidents/{incidentId}/restart. |
urlscan.urlscan_copy_incident | Read read | 2 | Copy Incident Official urlscan.io endpoint: POST /api/v1/user/incidents/{incidentId}/copy. |
urlscan.urlscan_fork_incident | Read read | 2 | Fork Incident Official urlscan.io endpoint: POST /api/v1/user/incidents/{incidentId}/fork. |
urlscan.urlscan_get_watchable_attributes | Read read | 0 | Get Watchable Attributes Official urlscan.io endpoint: GET /api/v1/user/watchableAttributes. |
urlscan.urlscan_get_incident_states | Read read | 1 | Get Incident States Official urlscan.io endpoint: GET /api/v1/user/incidentstates/{incidentId}/. |
urlscan.urlscan_list_datadumps | Read read | 3 | List Data Dump Files Official urlscan.io endpoint: GET /api/v1/datadump/list/{timeWindow}/{fileType}/{date}. |
urlscan.urlscan_get_datadump_link | Read read | 1 | Get Data Dump Download Link Official urlscan.io endpoint: GET /api/v1/datadump/link/{path}. |
urlscan.urlscan_download_file | Read read | 3 | Download a file Official urlscan.io endpoint: GET /downloads/{fileHash}. |
urlscan.urlscan_lookup_malicious_observable | Read read | 2 | Malicious observable lookup Official urlscan.io endpoint: GET /api/v1/malicious/{type}/{value}. |