function
stringlengths 375
1.49k
|
|---|
{
"name": "vt_validate_historical_ssl_certificates",
"description": "This function takes historical SSL certificates as input and checks if there is at least one valid SSL certificate present inside the provided historical data. It validates the SSL certificate by checking whether it is not expired and its issuing authority is trustworthy.",
"parameters": {
"properties": {
"historical_ssl_certificates": {
"description": "List of SSL certificates in the history",
"type": "array",
"items": {
"type": "object"
}
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"historical_ssl_certificates",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_threat_actors_main_source_region",
"description": "This function takes a list of threat actor objects and returns the primary source region among them. Each threat actor object has an attribute 'source region', and the function analyses this attribute across all objects to determine and return the most common source region, deemed as the 'main' source region.",
"parameters": {
"properties": {
"threat_actors": {
"description": "List of threat actor objects",
"type": "array",
"items": {
"type": "object"
}
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"threat_actors",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_threat_actors_latest_modification_date",
"description": "This function retrieves the latest modification date from a list of threat actor objects. It iterates through each threat actor object, checks its modification date, and returns the most recent modification date.",
"parameters": {
"properties": {
"threat_actor_objects": {
"description": "A list of threat actor objects.",
"type": "array",
"items": {
"type": "object"
}
},
"x_apikey": {
"description": "Your API key.",
"type": "string"
}
},
"required": [
"threat_actor_objects",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "convert_unix_timestamp_to_date",
"description": "Converts a UNIX timestamp to a human-readable date in the format 'YYYY/MM/DD'.",
"parameters": {
"properties": {
"unix_timestamp": {
"description": "The UNIX timestamp to be converted.",
"type": "integer"
}
},
"required": [
"unix_timestamp"
],
"type": "object"
}
} |
{
"name": "vt_is_date_within_range",
"description": "Checks if a given Unix timestamp is within a specified date range. The range is specified by 'start' and 'end' dates formatted as 'YYYY/MM/DD'. It's permissible for only one of 'start' or 'end' to be present in the function call. If 'start' is not provided, the function checks if the timestamp is earlier than or equal to the 'end' date. Similarly, if 'end' is not provided, the function checks if the timestamp is later than or equal to the 'start' date.",
"parameters": {
"properties": {
"timestamp": {
"description": "Unix timestamp",
"type": "integer"
},
"start": {
"description": "Start of the date range in 'YYYY/MM/DD' format",
"type": "string"
},
"end": {
"description": "End of the date range in 'YYYY/MM/DD' format",
"type": "string"
}
},
"required": [
"timestamp"
],
"type": "object"
}
} |
{
"name": "vt_get_last_analysis_date_from_report",
"description": "This function retrieves the last analysis date from the domain report collected by VirusTotal. The returned date is in Unix timestamp format.",
"parameters": {
"properties": {
"report": {
"description": "The domain report collected by vt_get_domain_report function.",
"type": "object"
}
},
"required": [
"report"
],
"type": "object"
}
} |
{
"name": "vt_get_comments_on_multiple_domains",
"description": "This function will retrieve comments for each specified domain in the given list.",
"parameters": {
"properties": {
"domains": {
"description": "List of domain names",
"type": "array",
"items": {
"type": "string"
}
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve for each domain",
"type": "integer"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"domains",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_multiple_domain_reports",
"description": "Retrieves reports for a list of domains provided. For each domain in the list, it requests the collected information regarding that domain from VirusTotal.",
"parameters": {
"properties": {
"domains": {
"description": "A list of Domain names",
"type": "array",
"items": {
"type": "string"
}
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"domains",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_majority_vote",
"description": "This function takes a dictionary of votes and returns the name with the majority votes. If the votes are equal, it will return the first encountered key in the dictionary.",
"parameters": {
"properties": {
"votes": {
"description": "Dictionary of votes",
"type": "object"
}
},
"required": [
"votes"
],
"type": "object"
}
} |
{
"name": "count_items_in_list",
"description": "This function takes a list as an input and returns the number of items present in the list.",
"parameters": {
"properties": {
"input_list": {
"description": "List whose items are to be counted",
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"input_list"
],
"type": "object"
}
} |
{
"name": "extract_resolution_date",
"description": "Extracts the date of DNS resolution from a DNS resolution object. The date is returned as a Unix timestamp.",
"parameters": {
"properties": {
"dns_res_obj": {
"description": "The DNS resolution object from which the date of resolution is to be extracted.",
"type": "object"
}
},
"required": [
"dns_res_obj"
],
"type": "object"
}
} |
{
"name": "calculate_sum_of_numbers",
"description": "Computes the sum of two numbers provided. Input numbers can be either integer or floating-point values.",
"parameters": {
"properties": {
"num1": {
"description": "The first number",
"type": "number"
},
"num2": {
"description": "The second number",
"type": "number"
}
},
"required": [
"num1",
"num2"
],
"type": "object"
}
} |
{
"name": "get_first_object_from_list",
"description": "Retrieves the first object from a given list. If the list is empty, it returns `None`.",
"parameters": {
"properties": {
"list_of_objects": {
"description": "List containing objects from which the function will pick out the first object.",
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"list_of_objects"
],
"type": "object"
}
} |
{
"name": "get_random_object_from_list",
"description": "This function selects and returns a random object from a list of objects. It is designed to handle any list length, including empty lists.",
"parameters": {
"properties": {
"list_of_objects": {
"description": "List containing objects from which the function will pick out a random object.",
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"list_of_objects"
],
"type": "object"
}
} |
{
"name": "resolve_ip_to_domain_and_parent_domain",
"description": "Resolves an IP address to its associated domain and parent domain. This function leverages DNS resolution to determine the domain associated with the given IP address and then extracts the parent domain from the resolved domain.",
"parameters": {
"properties": {
"ip_address": {
"description": "The IP address to be resolved.",
"type": "string"
}
},
"required": [
"ip_address"
],
"type": "object"
}
} |
{
"name": "extract_domain_and_parent_domain",
"description": "Extracts the domain and parent domain from a given URL.",
"parameters": {
"properties": {
"url": {
"description": "The URL from which to extract the domain and parent domain.",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
} |
{
"name": "merge_two_lists",
"description": "Merges two lists of objects into a single list. This function takes in two lists and returns a combined list containing elements from both lists. Duplicates are not removed.",
"parameters": {
"properties": {
"list1": {
"description": "The first list of objects to be merged.",
"type": "array",
"items": {
"type": "object"
}
},
"list2": {
"description": "The second list of objects to be merged.",
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"list1",
"list2"
],
"type": "object"
}
} |
{
"name": "vt_get_votes_on_ip_address",
"description": "This function will retrieve votes on a provided IP address.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
}
},
"required": [
"ip"
],
"type": "object"
}
} |
{
"name": "vt_get_comments_on_domain",
"description": "This function will retrieve comments on a specified domain.",
"parameters": {
"properties": {
"domain": {
"description": "Domain name",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve",
"type": "integer",
"format": "int32"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"domain",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_object_descriptors_related_to_domain",
"description": "This function returns related object's IDs (and context attributes, if any) for a given domain. It will not return all attributes but will provide objects relating to the specified domain. Relationships include caa_records, cname_records, comments, communicating_files, downloaded_files, graphs, historical_ssl_certificates, historical_whois, immediate_parent, mx_records, ns_records, parent, referrer_files, related_comments, related_references, related_threat_actors, resolutions, soa_records, siblings, subdomains, urls, and user_votes.",
"parameters": {
"properties": {
"domain": {
"description": "Domain name",
"type": "string"
},
"relationship": {
"description": "Relationship name (see description for possible values)",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve",
"type": "integer"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"domain",
"relationship",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_objects_related_to_domain",
"description": "This function returns all of the objects related to the specified domain, based on the specified relationship. Valid relationships include caa_records, cname_records, comments, communicating_files, downloaded_files, graphs, historical_ssl_certificates, historical_whois, immediate_parent, mx_records, ns_records, parent, referrer_files, related_comments, related_references, related_threat_actors, resolutions, soa_records, siblings, subdomains, urls, and user_votes.",
"parameters": {
"properties": {
"domain": {
"description": "Domain name",
"type": "string"
},
"relationship": {
"description": "Relationship name",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve",
"type": "integer"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"domain",
"relationship",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_object_descriptors_related_to_ip_address",
"description": "This function returns related object's IDs (and context attributes, if any) for a given IP address based on the specified relationship. Note that this will not return all attributes. The valid relationships include comments, communicating_files, downloaded_files, graphs, historical_ssl_certificates, historical_whois, related_comments, related_references, related_threat_actors, referrer_files, resolutions, and urls.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
},
"relationship": {
"description": "Relationship name (e.g., comments, communicating_files, downloaded_files, etc.)",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve",
"type": "integer"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"ip",
"relationship",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_add_comment_to_ip_address",
"description": "With this function you can post a comment for a given IP address. The body for the POST request must be the JSON representation of a comment object. Notice however that you don't need to provide an ID for the object, as they are automatically generated for new comments. Any word starting with # in your comment's text will be considered a tag, and added to the comment's tag attribute. Returns a Comment object.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
},
"data": {
"description": "A comment object",
"type": "object"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"ip",
"data",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_comments_on_ip_address",
"description": "Retrieves the comments on a provided IP address. Returns a list of Comment objects.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve",
"type": "integer"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"ip",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_domain_report",
"description": "Retrieves a domain report. These reports contain information regarding the domain itself that VirusTotal has collected.",
"parameters": {
"properties": {
"domain": {
"description": "Domain name",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"domain",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_add_votes_to_ip_address",
"description": "With this function you can post a vote for a given file. The body for the POST request must be the JSON representation of a vote object. Note however that you don't need to provide an ID for the object, as they are automatically generated for new votes. The verdict attribute must have be either harmless or malicious.\nPlease ensure that the JSON object you provide conforms accurately to valid JSON standards.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
},
"data": {
"description": "Vote object",
"type": "object"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"ip",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_ip_address_report",
"description": "Retrieve an IP address report. These reports condense all of the recent activity that VirusTotal has seen for the resource under consideration, as well as contextual information about it. This function specifically generates these reports using the IP address parameter.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
},
"x-apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"ip",
"x-apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_objects_related_to_ip_address",
"description": "IP addresses have a number of relationships to other objects. This function returns ALL objects that fit the specified relationship. The relationships include comments, communicating_files, downloaded_files, graphs, historical_ssl_certificates, historical_whois, related_comments, related_references, related_threat_actors, referrer_files, resolutions, and urls. Each relationship returns a list of the corresponding objects.",
"parameters": {
"properties": {
"ip": {
"description": "IP address",
"type": "string"
},
"relationship": {
"description": "Relationship name (e.g., comments, communicating_files, downloaded_files, etc.)",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
},
"limit": {
"description": "Maximum number of comments to retrieve",
"type": "integer"
},
"cursor": {
"description": "Continuation cursor",
"type": "string"
}
},
"required": [
"ip",
"relationship",
"x_apikey"
],
"type": "object"
}
} |
{
"name": "vt_get_dns_resolution_object",
"description": "This endpoint retrieves a Resolution object by its ID. A resolution object ID is made by appending the IP and the domain it resolves to together. Resolution objects include attributes such as date (UTC timestamp), host_name (domain or subdomain requested), host_name_last_analysis_stats (last detection stats from the resolution's domain), ip_address (IP address the domain was resolved to), ip_address_last_analysis_stats (last detection stats from the resolution's IP address), and resolver (source of the resolution).",
"parameters": {
"properties": {
"id": {
"description": "Resolution object ID",
"type": "string"
},
"x_apikey": {
"description": "Your API key",
"type": "string"
}
},
"required": [
"id",
"x_apikey"
],
"type": "object"
}
} |