Create a Saved Search

Use this endpoint to save a search or query and you will automatically become the owner of the saved search. This is an example request body:

{
    "data": {
        "type": "saved_search",
        "attributes": {
            "name": "saved search's name",
            "description": "saved search's description",
            "search_query": "saved search's query/logic",
            "private": true,
            "tags": ["saved search's associated tags"]
        }
    }
}

The private field determines the search's accessibility:

  • if set to false (public), the saved search is viewable by all Google Threat Intelligence users.
  • if set to true (private), access is restricted to the owner and any specific users/groups with whom the owner has individually shared the search.

To update the private field check out this endpoint .

To share a saved search with certain users or the owner's entire group, check out this endpoint .

Examples

import requests

url = f"https://www.virustotal.com/api/v3/saved_searches"
payload = {
    "data": {
        "type": "saved_search",
        "attributes": {
            "name": "Potential Gamaredon-related document activity",
            "description": "This Intelligence search query is designed to find files that match a specific set of characteristics, generally indicative of a particular type of malware or activity.",
            "search_query": "(type:document) and (behavior_processes:*.ru* and behavior_processes:*DavSetCookie* and behavior_processes:*http*) and (behavior_network:*.ru* or embedded_domain:*.ru* or embedded_url:*.ru*)",
            "private": True,
            "tags": ["FILE", "Gamaredon", "Behaviour"]
        }
    }
}
headers = {"accept": "application/json","x-apikey": <api-key>,"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
Query Params
string

Provides additional information about the saved search as relationships

string

A comma-separated list of the saved search attributes to be returned. (All attributes are returned by default.)

Body Params
data
object
required

Payload to post.

Headers
string
required

Your AP Key.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json