{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Documentation Hub","link":"/","routeSlug":"/"},{"type":"link","fsPath":"guides/quickstart.md","metadata":{"type":"markdown"},"label":"Quickstart Guide","link":"/guides/quickstart","routeSlug":"/guides/quickstart"},{"type":"group","label":"Concepts","items":[{"type":"link","fsPath":"pages/visibility.md","metadata":{"type":"markdown"},"label":"Scan Visibility","link":"/pages/visibility","routeSlug":"/pages/visibility"},{"type":"link","fsPath":"pages/faq.md","metadata":{"type":"markdown"},"label":"Frequently Asked Questions","link":"/pages/faq","routeSlug":"/pages/faq"},{"type":"link","fsPath":"pages/user-accounts.md","metadata":{"type":"markdown"},"label":"User & Team Accounts","link":"/pages/user-accounts","routeSlug":"/pages/user-accounts"}]},{"type":"group","label":"urlscan Pro","items":[{"type":"link","fsPath":"pages/urlscan-pro.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/pages/urlscan-pro","routeSlug":"/pages/urlscan-pro"},{"type":"link","fsPath":"pages/pro-use-cases.md","metadata":{"type":"markdown"},"label":"Use Cases","link":"/pages/pro-use-cases","routeSlug":"/pages/pro-use-cases"},{"type":"group","label":"Data Sources","items":[{"type":"link","fsPath":"pages/source-scans.md","metadata":{"type":"markdown"},"label":"Website Scans","link":"/pages/source-scans","routeSlug":"/pages/source-scans"},{"type":"link","fsPath":"pages/source-hostnames.md","metadata":{"type":"markdown"},"label":"Domains & Hostnames","link":"/pages/source-hostnames","routeSlug":"/pages/source-hostnames"},{"type":"link","fsPath":"pages/source-certificates.md","metadata":{"type":"markdown"},"label":"TLS Certificates","link":"/pages/source-certificates","routeSlug":"/pages/source-certificates"},{"type":"link","fsPath":"pages/source-files.md","metadata":{"type":"markdown"},"label":"Downloaded Files","link":"/pages/source-files","routeSlug":"/pages/source-files"}]},{"type":"link","fsPath":"pages/brand-detection.md","metadata":{"type":"markdown"},"label":"Brand & Phishing Detection","link":"/pages/brand-detection","routeSlug":"/pages/brand-detection"},{"type":"link","fsPath":"pages/livescanning.md","metadata":{"type":"markdown"},"label":"Quick Scanning & Live Browsing","link":"/pages/livescanning","routeSlug":"/pages/livescanning"},{"type":"link","fsPath":"pages/saved-searches.md","metadata":{"type":"markdown"},"label":"Saved Searches","link":"/pages/saved-searches","routeSlug":"/pages/saved-searches"},{"type":"link","fsPath":"pages/subscriptions.md","metadata":{"type":"markdown"},"label":"Subscriptions","link":"/pages/subscriptions","routeSlug":"/pages/subscriptions"},{"type":"link","fsPath":"pages/urlscan-observe.md","metadata":{"type":"markdown"},"label":"urlscan Observe","link":"/pages/urlscan-observe","routeSlug":"/pages/urlscan-observe"},{"type":"link","fsPath":"pages/visual-search.md","metadata":{"type":"markdown"},"label":"Visual Search","link":"/pages/visual-search","routeSlug":"/pages/visual-search"},{"type":"link","fsPath":"pages/structure-search.md","metadata":{"type":"markdown"},"label":"Structure Search","link":"/pages/structure-search","routeSlug":"/pages/structure-search"},{"type":"link","fsPath":"pages/labels.md","metadata":{"type":"markdown"},"label":"System Labels","link":"/pages/labels","routeSlug":"/pages/labels"}]},{"type":"group","fsPath":"pages/search-general.md","metadata":{"type":"markdown"},"label":"Search API","link":"/pages/search-general","routeSlug":"/pages/search-general","items":[{"type":"link","fsPath":"pages/search-api-reference.md","metadata":{"type":"markdown"},"label":"Website Scans","link":"/pages/search-api-reference","routeSlug":"/pages/search-api-reference"},{"type":"link","fsPath":"pages/hostname-search.md","metadata":{"type":"markdown"},"label":"Hostnames","link":"/pages/hostname-search","routeSlug":"/pages/hostname-search"},{"type":"link","fsPath":"pages/certificates-search.md","metadata":{"type":"markdown"},"label":"Certificates","link":"/pages/certificates-search","routeSlug":"/pages/certificates-search"},{"type":"link","fsPath":"pages/files-search.md","metadata":{"type":"markdown"},"label":"Files","link":"/pages/files-search","routeSlug":"/pages/files-search"},{"type":"link","fsPath":"pages/incidents-search.md","metadata":{"type":"markdown"},"label":"Incidents","link":"/pages/incidents-search","routeSlug":"/pages/incidents-search"},{"type":"link","fsPath":"pages/notifications-search.md","metadata":{"type":"markdown"},"label":"Notifications","link":"/pages/notifications-search","routeSlug":"/pages/notifications-search"}]},{"type":"group","label":"API Reference","items":[{"type":"link","fsPath":"pages/api-intro.md","metadata":{"type":"markdown"},"label":"API Introduction","link":"/pages/api-intro","routeSlug":"/pages/api-intro"},{"type":"link","fsPath":"pages/api-best-practices.md","metadata":{"type":"markdown"},"label":"API Best Practices","link":"/pages/api-best-practices","routeSlug":"/pages/api-best-practices"},{"type":"link","fsPath":"pages/api-integrations.md","metadata":{"type":"markdown"},"label":"API Integrations","link":"/pages/api-integrations","routeSlug":"/pages/api-integrations"},{"type":"link","fsPath":"pages/api-rate-limits.md","metadata":{"type":"markdown"},"label":"API Rate Limits","link":"/pages/api-rate-limits","routeSlug":"/pages/api-rate-limits"},{"type":"link","fsPath":"pages/error-codes.md","metadata":{"type":"markdown"},"label":"API Error Codes","link":"/pages/error-codes","routeSlug":"/pages/error-codes"},{"type":"link","fsPath":"pages/result-api-reference.md","metadata":{"type":"markdown"},"label":"Result API Reference","link":"/pages/result-api-reference","routeSlug":"/pages/result-api-reference"},{"type":"link","fsPath":"pages/hostname-history.md","metadata":{"type":"markdown"},"label":"Hostname History API Reference","link":"/pages/hostname-history","routeSlug":"/pages/hostname-history"}]},{"type":"group","fsPath":"apis/urlscan-openapi.yaml","link":"/apis/urlscan-openapi","routeSlug":"/apis/urlscan-openapi","label":"API Endpoints","items":[{"type":"link","label":"Introduction","link":"/apis/urlscan-openapi/section/introduction","routeSlug":"/apis/urlscan-openapi/section/introduction"},{"type":"link","label":"External Resources","link":"/apis/urlscan-openapi/section/external-resources","routeSlug":"/apis/urlscan-openapi/section/external-resources"},{"type":"group","label":"Generic","link":"/apis/urlscan-openapi/generic","routeSlug":"/apis/urlscan-openapi/generic","items":[{"label":"API Quotas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/generic/getquotas","routeSlug":"/apis/urlscan-openapi/generic/getquotas","metadata":{"seo":{"title":"API Quotas","description":"API Endpoint to get available and used API quotas."}},"httpPath":"/api/v1/quotas"},{"label":"User Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/generic/getusername","routeSlug":"/apis/urlscan-openapi/generic/getusername","metadata":{"seo":{"title":"User Information","description":"Get information about the current user or API key making the request."}},"httpPath":"/user/username"}]},{"type":"group","label":"Scanning","link":"/apis/urlscan-openapi/scanning","routeSlug":"/apis/urlscan-openapi/scanning","items":[{"label":"Scan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/submitscan","routeSlug":"/apis/urlscan-openapi/scanning/submitscan","metadata":{"seo":{"title":"Scan","description":"Submit a URL to be scanned and control options for how the scan should be performed."}},"httpPath":"/api/v1/scan"},{"label":"Result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/getresult","routeSlug":"/apis/urlscan-openapi/scanning/getresult","metadata":{"seo":{"title":"Result","description":"Using the Scan ID received from the Submission API, you can use the Result API to poll for the scan. The most efficient approach would be to wait at least 10 seconds before starting to poll, and then only polling 2-second intervals with an eventual upper timeout in case the scan does not return."}},"httpPath":"/api/v1/result/{scanId}/"},{"label":"Screenshot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/getscreenshot","routeSlug":"/apis/urlscan-openapi/scanning/getscreenshot","metadata":{"seo":{"title":"Screenshot","description":"Use the scan UUID to retrieve the screenshot for a scan once the scan has finished."}},"httpPath":"/screenshots/{scanId}.png"},{"label":"DOM","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/getdom","routeSlug":"/apis/urlscan-openapi/scanning/getdom","metadata":{"seo":{"title":"DOM","description":"Use the scan UUID to retrieve the DOM snapshot for a scan once the scan has finished."}},"httpPath":"/dom/{scanId}/"},{"label":"Response","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/getresponse","routeSlug":"/apis/urlscan-openapi/scanning/getresponse","metadata":{"seo":{"title":"Response","description":"Get a (Script|Document|Fetch|XHR) response in plain text format by SHA256 hash. Note that this endpoint returns the content as text/plain. If you need to download a binary file (like a ZIP file, etc.), use the Download a file endpoint instead."}},"httpPath":"/responses/{fileHash}/"},{"label":"Update Result Visibility","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/updateresultvisibility","routeSlug":"/apis/urlscan-openapi/scanning/updateresultvisibility","metadata":{"seo":{"title":"Update Result Visibility","description":"urlscan Pro - Change the visibility of a scan owned by you or your team."}},"httpPath":"/api/v1/result/{scanId}/visibility/"},{"label":"Reset to original visibility","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/deleteresultvisibility","routeSlug":"/apis/urlscan-openapi/scanning/deleteresultvisibility","metadata":{"seo":{"title":"Reset to original visibility","description":"urlscan Pro - Reset the visibility of a scan owned by you or your team to its original visibility"}},"httpPath":"/api/v1/result/{scanId}/visibility/"},{"label":"Available Countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/getavailablecountries","routeSlug":"/apis/urlscan-openapi/scanning/getavailablecountries","metadata":{"seo":{"title":"Available Countries","description":"Retrieve countries available for scanning using the Scan API"}},"httpPath":"/api/v1/availableCountries"},{"label":"Available User Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/scanning/getuseragents","routeSlug":"/apis/urlscan-openapi/scanning/getuseragents","metadata":{"seo":{"title":"Available User Agents","description":"Get grouped user agents to use with the Scan API."}},"httpPath":"/api/v1/userAgents"}]},{"type":"group","label":"Search","link":"/apis/urlscan-openapi/search","routeSlug":"/apis/urlscan-openapi/search","items":[{"label":"Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/search/searchdatasource","routeSlug":"/apis/urlscan-openapi/search/searchdatasource","metadata":{"seo":{"title":"Search","description":"The Search API is used to find historical scans performed on theplatform. Some data sources and searchable fields are only available on urlscan Pro."}},"httpPath":"/api/v1/search"},{"label":"Structure Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/search/getsimilarresults","routeSlug":"/apis/urlscan-openapi/search/getsimilarresults","metadata":{"seo":{"title":"Structure Search","description":"urlscan Pro - Get structurally similar results to a specific scan. Seedescription for this propietary feature on urlscanPro."}},"httpPath":"/api/v1/pro/result/{scanId}/similar/"},{"label":"Phishfeed","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/search/getphishfeed","routeSlug":"/apis/urlscan-openapi/search/getphishfeed","metadata":{"seo":{"title":"Phishfeed","description":"urlscan Pro - The Phishing URL endpoint is a convenience method over the Search API for retrieving detected pages. Unless you have a specific reason not to, you should use the Search API instead!"}},"httpPath":"/api/v1/pro/phishfeed"}]},{"type":"group","label":"Live Scanning","link":"/apis/urlscan-openapi/live-scanning","routeSlug":"/apis/urlscan-openapi/live-scanning","items":[{"label":"Live Scanners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/live-scanning/getlivescanscanners","routeSlug":"/apis/urlscan-openapi/live-scanning/getlivescanscanners","metadata":{"seo":{"title":"Live Scanners","description":"API Endpoint to a list of available Live Scanning nodes along with their current metadata."}},"httpPath":"/api/v1/livescan/scanners/"},{"label":"Non-Blocking Trigger Live Scan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/live-scanning/createlivescantask","routeSlug":"/apis/urlscan-openapi/live-scanning/createlivescantask","metadata":{"seo":{"title":"Non-Blocking Trigger Live Scan","description":"Task a URL to be scanned. The HTTP request will return with the scan UUID immediately and then it is your responsibility to poll the result resource type until the scan has finished."}},"httpPath":"/api/v1/livescan/{scannerId}/task/"},{"label":"Trigger Live Scan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/live-scanning/createlivescanscan","routeSlug":"/apis/urlscan-openapi/live-scanning/createlivescanscan","metadata":{"seo":{"title":"Trigger Live Scan","description":"Task a URL to be scanned. The HTTP request will block until the scan has finished."}},"httpPath":"/api/v1/livescan/{scannerId}/scan/"},{"label":"Live Scan Get Resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/live-scanning/getlivescanresource","routeSlug":"/apis/urlscan-openapi/live-scanning/getlivescanresource","metadata":{"seo":{"title":"Live Scan Get Resource","description":"Retrieve the resource for a particular scan ID or SHA256 from this live scanner."}},"httpPath":"/api/v1/livescan/{scannerId}/{resourceType}/{resourceId}"},{"label":"Store Live Scan Result","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/live-scanning/storelivescanresult","routeSlug":"/apis/urlscan-openapi/live-scanning/storelivescanresult","metadata":{"seo":{"title":"Store Live Scan Result","description":"Store the temporary scan as a permanent snapshot on urlscan.io."}},"httpPath":"/api/v1/livescan/{scannerId}/{scanId}/"},{"label":"Purge Live Scan Result","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/live-scanning/discardlivescanresult","routeSlug":"/apis/urlscan-openapi/live-scanning/discardlivescanresult","metadata":{"seo":{"title":"Purge Live Scan Result","description":"Purge temporary scan from scanner immediately. Scans will be automatically purged after 60 minutes."}},"httpPath":"/api/v1/livescan/{scannerId}/{scanId}/"}]},{"type":"group","label":"Saved Searches","link":"/apis/urlscan-openapi/saved-searches","routeSlug":"/apis/urlscan-openapi/saved-searches","items":[{"label":"Saved Searches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/saved-searches/listsavedsearches","routeSlug":"/apis/urlscan-openapi/saved-searches/listsavedsearches","metadata":{"seo":{"title":"Saved Searches","description":"Get a list of Saved Searches for the current user."}},"httpPath":"/api/v1/user/searches/"},{"label":"Create Saved Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/saved-searches/createsavedsearch","routeSlug":"/apis/urlscan-openapi/saved-searches/createsavedsearch","metadata":{"seo":{"title":"Create Saved Search","description":"Create a Saved Search."}},"httpPath":"/api/v1/user/searches/"},{"label":"Update Saved Search","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/saved-searches/updatesavedsearch","routeSlug":"/apis/urlscan-openapi/saved-searches/updatesavedsearch","metadata":{"seo":{"title":"Update Saved Search","description":"Update a Saved Search."}},"httpPath":"/api/v1/user/searches/{searchId}/"},{"label":"Delete Saved Search","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/saved-searches/deletesavedsearch","routeSlug":"/apis/urlscan-openapi/saved-searches/deletesavedsearch","metadata":{"seo":{"title":"Delete Saved Search","description":"Delete a Saved Search"}},"httpPath":"/api/v1/user/searches/{searchId}/"},{"label":"Saved Search Search Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/saved-searches/getsavedsearchresults","routeSlug":"/apis/urlscan-openapi/saved-searches/getsavedsearchresults","metadata":{"seo":{"title":"Saved Search Search Results","description":"Get the search results for a specific Saved Search."}},"httpPath":"/api/v1/user/searches/{searchId}/results/"}]},{"type":"group","label":"Subscriptions","link":"/apis/urlscan-openapi/subscriptions","routeSlug":"/apis/urlscan-openapi/subscriptions","items":[{"label":"Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/subscriptions/listsubscriptions","routeSlug":"/apis/urlscan-openapi/subscriptions/listsubscriptions","metadata":{"seo":{"title":"Subscriptions","description":"Get a list of Subscriptions for the current user."}},"httpPath":"/api/v1/user/subscriptions/"},{"label":"Create Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/subscriptions/createsubscription","routeSlug":"/apis/urlscan-openapi/subscriptions/createsubscription","metadata":{"seo":{"title":"Create Subscription","description":"Create a new subscription."}},"httpPath":"/api/v1/user/subscriptions/"},{"label":"Update Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/subscriptions/updatesubscription","routeSlug":"/apis/urlscan-openapi/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update Subscription","description":"Update the settings for a subscription."}},"httpPath":"/api/v1/user/subscriptions/{subscriptionId}/"},{"label":"Delete Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/subscriptions/deletesubscription","routeSlug":"/apis/urlscan-openapi/subscriptions/deletesubscription","metadata":{"seo":{"title":"Delete Subscription","description":"Delete a subscription."}},"httpPath":"/api/v1/user/subscriptions/{subscriptionId}/"},{"label":"Subscription Search Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/subscriptions/getsubscriptionresults","routeSlug":"/apis/urlscan-openapi/subscriptions/getsubscriptionresults","metadata":{"seo":{"title":"Subscription Search Results","description":"Get the search results for a specific subscription and datasource."}},"httpPath":"/api/v1/user/subscriptions/{subscriptionId}/results/{datasource}/"}]},{"type":"group","label":"Hostnames","link":"/apis/urlscan-openapi/hostnames","routeSlug":"/apis/urlscan-openapi/hostnames","items":[{"label":"Hostname History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/hostnames/gethostnamehistory","routeSlug":"/apis/urlscan-openapi/hostnames/gethostnamehistory","metadata":{"seo":{"title":"Hostname History","description":"Get the historical observations for a specific hostname in the \"Hostnames\" data source."}},"httpPath":"/api/v1/hostname/{hostname}"}]},{"type":"group","label":"Brands","link":"/apis/urlscan-openapi/brands","routeSlug":"/apis/urlscan-openapi/brands","items":[{"label":"Available Brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/brands/getavailablebrands","routeSlug":"/apis/urlscan-openapi/brands/getavailablebrands","metadata":{"seo":{"title":"Available Brands","description":"API Endpoint to get a list of brands that are tracked as part of urlscan's brand and phishing detection."}},"httpPath":"/api/v1/pro/availableBrands"},{"label":"Brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/brands/getbrandsummary","routeSlug":"/apis/urlscan-openapi/brands/getbrandsummary","metadata":{"seo":{"title":"Brands","description":"Get the list of brands that we are able to detect phishing pages, the total number of detected pages and the latest hit for each brand. This is slower than the availableBrands endpoint."}},"httpPath":"/api/v1/pro/brands"}]},{"type":"group","label":"Files","link":"/apis/urlscan-openapi/files","routeSlug":"/apis/urlscan-openapi/files","items":[{"label":"Download a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/files/downloadfile","routeSlug":"/apis/urlscan-openapi/files/downloadfile","metadata":{"seo":{"title":"Download a file","description":"urlscan Pro - Download a file by SHA256 hash. For the ZIP files delivered by thisendpoint, the default encryption password is urlscan! - including thetrailing exclamation mark. The ZIP file contains a single file namedafter the SHA256 of the requested file."}},"httpPath":"/downloads/{fileHash}"}]},{"type":"group","label":"Incidents","link":"/apis/urlscan-openapi/incidents","routeSlug":"/apis/urlscan-openapi/incidents","items":[{"label":"Create Incident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/createincident","routeSlug":"/apis/urlscan-openapi/incidents/createincident","metadata":{"seo":{"title":"Create Incident","description":"Create an incident with specific options"}},"httpPath":"/api/v1/user/incidents"},{"label":"Get Incident","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/getincident","routeSlug":"/apis/urlscan-openapi/incidents/getincident","metadata":{"seo":{"title":"Get Incident","description":"Get details for a specific incident."}},"httpPath":"/api/v1/user/incidents/{incidentId}"},{"label":"Update Incident options","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/updateincident","routeSlug":"/apis/urlscan-openapi/incidents/updateincident","metadata":{"seo":{"title":"Update Incident options","description":"Update specific runtime options of the incident"}},"httpPath":"/api/v1/user/incidents/{incidentId}"},{"label":"Close Incident","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/closeincident","routeSlug":"/apis/urlscan-openapi/incidents/closeincident","metadata":{"seo":{"title":"Close Incident","description":"Close (stop) the incident"}},"httpPath":"/api/v1/user/incidents/{incidentId}/close"},{"label":"Restart Incident","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/restartincident","routeSlug":"/apis/urlscan-openapi/incidents/restartincident","metadata":{"seo":{"title":"Restart Incident","description":"Restart a closed incident. Automatically extends the incident expireAt. Starts with new incident states."}},"httpPath":"/api/v1/user/incidents/{incidentId}/restart"},{"label":"Copy Incident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/copyincident","routeSlug":"/apis/urlscan-openapi/incidents/copyincident","metadata":{"seo":{"title":"Copy Incident","description":"Copy an incident without its history."}},"httpPath":"/api/v1/user/incidents/{incidentId}/copy"},{"label":"Fork Incident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/forkincident","routeSlug":"/apis/urlscan-openapi/incidents/forkincident","metadata":{"seo":{"title":"Fork Incident","description":"Copy an incident along with its history (incident states)."}},"httpPath":"/api/v1/user/incidents/{incidentId}/fork"},{"label":"Get Watchable Attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/getwatchableattributes","routeSlug":"/apis/urlscan-openapi/incidents/getwatchableattributes","metadata":{"seo":{"title":"Get Watchable Attributes","description":"Get the list of attributes which can be supplied to the watchedAttributes property of the incident."}},"httpPath":"/api/v1/user/watchableAttributes"},{"label":"Get Incident States","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/incidents/getincidentstates","routeSlug":"/apis/urlscan-openapi/incidents/getincidentstates","metadata":{"seo":{"title":"Get Incident States","description":"Retrieve individual incident states of an incident."}},"httpPath":"/api/v1/user/incidentstates/{incidentId}/"}]},{"type":"group","label":"Malicious","link":"/apis/urlscan-openapi/malicious","routeSlug":"/apis/urlscan-openapi/malicious","items":[{"label":"Malicious observable lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/malicious/lookupmaliciousobservable","routeSlug":"/apis/urlscan-openapi/malicious/lookupmaliciousobservable","metadata":{"seo":{"title":"Malicious observable lookup","description":"urlscan Pro - Look up how often an observable has been seen in malicious scan results,along with first and last seen timestamps."}},"httpPath":"/api/v1/malicious/{type}/{value}"}]},{"type":"group","label":"Channels","link":"/apis/urlscan-openapi/channels","routeSlug":"/apis/urlscan-openapi/channels","items":[{"label":"Channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/channels/listchannels","routeSlug":"/apis/urlscan-openapi/channels/listchannels","metadata":{"seo":{"title":"Channels","description":"Get a list of notification channels for the current user."}},"httpPath":"/api/v1/user/channels/"},{"label":"Create Channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/channels/createchannel","routeSlug":"/apis/urlscan-openapi/channels/createchannel","metadata":{"seo":{"title":"Create Channel","description":"Create a new channel."}},"httpPath":"/api/v1/user/channels/"},{"label":"Channel Search Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/channels/getchannel","routeSlug":"/apis/urlscan-openapi/channels/getchannel","metadata":{"seo":{"title":"Channel Search Results","description":"Get the search results for a specific notification channel."}},"httpPath":"/api/v1/user/channels/{channelId}"},{"label":"Update Channel","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/channels/updatechannel","routeSlug":"/apis/urlscan-openapi/channels/updatechannel","metadata":{"seo":{"title":"Update Channel","description":"Update an existing channel."}},"httpPath":"/api/v1/user/channels/{channelId}"}]},{"type":"group","label":"Data Dumps","link":"/apis/urlscan-openapi/data-dumps","routeSlug":"/apis/urlscan-openapi/data-dumps","items":[{"label":"List Data Dump Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/data-dumps/listdatadumps","routeSlug":"/apis/urlscan-openapi/data-dumps/listdatadumps","metadata":{"seo":{"title":"List Data Dump Files","description":"urlscan Pro - List available data dump files for a specific time window, file type, and date."}},"httpPath":"/api/v1/datadump/list/{timeWindow}/{fileType}/{date}"},{"label":"Get Data Dump Download Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/urlscan-openapi/data-dumps/getdatadumplink","routeSlug":"/apis/urlscan-openapi/data-dumps/getdatadumplink","metadata":{"seo":{"title":"Get Data Dump Download Link","description":"urlscan Pro - Generate a temporary download link for a specific data dump file."}},"httpPath":"/api/v1/datadump/link/{path}"}]}],"metadata":{"type":"openapi","title":"urlscan.io APIs","version":"1.0.0","description":"### Introduction\n\nAPI endpoints for urlscan.io and urlscan Pro. Most of these API endpoints\nrequire authentication.\n\nThe fastest way to start working with our APIs is by using one of the many\nexisting commercial or open-source integrations.\n\n### External Resources\n* [urlscan.io website](https://urlscan.io)\n* [urlscan.io Documentation Hub](https://docs.urlscan.io)\n* [urlscan.io API Status](https://status.urlscan.io)\n"}},{"type":"group","label":"Tools","items":[{"type":"link","fsPath":"pages/cli-intro.md","metadata":{"type":"markdown"},"label":"CLI - Introduction","link":"/pages/cli-intro","routeSlug":"/pages/cli-intro"},{"type":"link","link":"","label":"urlscan-cli"}]},{"type":"group","label":"External Resources","items":[{"type":"link","link":"https://urlscan.io/pricing/","label":"Products & Pricing","external":true},{"type":"link","link":"https://urlscan.io/blog/","label":"urlscan Blog","external":true},{"type":"link","link":"https://github.com/urlscan/urlscan-python","label":"urlscan-python library","external":true},{"type":"link","link":"https://urlscan.io/docs/integrations/","label":"urlscan API Integrations","external":true},{"type":"link","link":"https://urlscan.io/security/","label":"Security","external":true}]},{"type":"link","fsPath":"changelog.md","metadata":{"type":"markdown"},"label":"API Changelog","link":"/changelog","routeSlug":"/changelog"},{"type":"link","fsPath":"about.md","metadata":{"type":"markdown"},"label":"About urlscan.io","link":"/about","routeSlug":"/about"}]}