Saved Searches

Update Saved Search

Update a Saved Search.

put/api/v1/user/searches/{searchId}/

Request

  • Base URL: https://urlscan.io
  • URL: https://urlscan.io/api/v1/user/searches/{searchId}/
  • Auth: API key in header api-key

Path parameters

searchIdstring required

Request body

Example request

{
  "search": {
    "datasource": "scans",
    "query": "page.domain:urlscan.io",
    "name": "Testsearch",
    "description": "urlscan documentation example saved search.",
    "longDescription": "Example saved search created from urlscan documentation.",
    "tlp": "red",
    "userTags": [
      "private.privatetag"
    ],
    "permissions": [
      "team:read",
      "team:write"
    ]
  }
}

Response

OK

Example response

{
  "search": {
    "_id": "{{searchId}}",
    "datasource": "scans",
    "query": "page.domain:urlscan.io",
    "name": "Testsearch",
    "description": "urlscan documentation example saved search.",
    "longDescription": "Example saved search created from urlscan documentation",
    "tlp": "red",
    "userTags": [
      "private.privatetag"
    ],
    "permissions": [
      "team:read",
      "team:write"
    ]
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.