Skip to content
API Endpoints/
/
Update Saved Search

Update Saved Search

Request

Update a Saved Search.

Security
apikeyAuth(Required scopes: readwrite)
Path
searchIdstringrequired
Example:{{searchId}}
Bodyapplication/json
searchobject(savedSearch)required
Example:
{
  "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"
  ]
}
PUT
/api/v1/user/searches/{searchId}/
curl -i -X PUT \
  'https://urlscan.io/api/v1/user/searches/{{searchId}}/' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
searchobject(savedSearchResponse)
Example:
{
  "_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"
  ]
}
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": [ … ],
    "permissions": [ … ]
  }
}