api_name
stringclasses 14
values | api_definition
stringclasses 14
values | dataset_name
stringclasses 2
values |
|---|---|---|
searchCVE | {
"name": "searchCVE",
"description": "Build and send GET request then return list of objects containing a collection of CVEs. For more information on the parameters available, please visit https://nvd.nist.gov/developers/vulnerabilities",
"parameters": {
"type": "object",
"properties": {
"cpeName": {
"type": "string",
"description": "The term to start with \'cpe\'. Partial match strings are allowed."
},
"cveId": {
"type": "string",
"description": "A string integer, like \'1\' or \'30\'."
},
"cvssV2Metrics": {
"type": "string",
"description": "It returns only the CVEs that match the provided CVSSv2 vector string."
},
"cvssV2Severity": {
"type": "string",
"description": "Find vulnerabilities having a LOW, MEDIUM, or HIGH version 2 severity."
},
"cvssV3Metrics": {
"type": "string",
"description": "It returns only the CVEs that match the provided CVSSv3 vector string."
},
"cvssV3Severity": {
"type": "string",
"description": "Find vulnerabilities having a LOW, MEDIUM, HIGH, or CRITICAL version 3 severity."
},
"cweId": {
"type": "string",
"description": "A string integer, like \'1\' or \'30\'."
},
"hasCertAlerts": {
"type": "boolean",
"description": "Returns CVE that contain a Technical Alert from US-CERT."
},
"hasCertNotes": {
"type": "boolean",
"description": "Returns CVE that contain a Vulnerability Note from CERT/CC."
},
"hasOval": {
"type": "boolean",
"description": "Returns CVE that contain information from MITRE\'s Open Vulnerability and Assessment Language (OVAL)."
},
"isVulnerable": {
"type": "boolean",
"description": "Returns CVE associated with a specific CPE, where the CPE is also considered vulnerable."
},
"keywordExactMatch": {
"type": "boolean",
"description": "It will search the NVD for CVEs containing exactly what was passed to keywordSearch."
},
"keywordSearch": {
"type": "string",
"description": "Searches CVEs where a word or phrase is found in the current description."
},
"lastModStartDate": {
"type": ["string", "object"],
"description": "These parameters return only the CVEs that were last modified during the specified period."
},
"lastModEndDate": {
"type": ["string", "object"],
"description": "Required if using lastModStartDate."
},
"noRejected": {
"type": "boolean",
"description": "Filters out all CVEs that are in a reject or rejected status."
},
"pubStartDate": {
"type": ["string", "object"],
"description": "These parameters return only the CVEs that were added to the NVD (i.e., published) during the specified period."
},
"pubEndDate": {
"type": ["string", "object"],
"description": "Required if using pubStartDate."
},
"sourceIdentifier": {
"type": "string",
"description": "Returns CVE where the data source of the CVE is the value that is passed to sourceIdentifier."
},
"versionEnd": {
"type": "string",
"description": "Must be combined with versionEndType and virtualMatchString."
},
"versionEndType": {
"type": "string",
"description": "Must be combined with versionEnd and virtualMatchString."
},
"versionStart": {
"type": "string",
"description": "Must be combined with versionStartType and virtualMatchString."
},
"versionStartType": {
"type": "string",
"description": "Must be combined with versionStart and virtualMatchString."
},
"virtualMatchString": {
"type": "string",
"description": "The cpe match string that is compared against the CPE Match Criteria."
},
"limit": {
"type": "integer",
"description": "Custom argument to limit the number of results."
},
"delay": {
"type": "integer",
"description": "This allows the user to define a delay."
},
"key": {
"type": "string",
"description": "NVD API Key."
},
"verbose": {
"type": "boolean",
"description": "Prints the URL request."
}
}
}
} | cvecpe |
searchCPE | {
"name": "searchCPE",
"description": "Build and send GET request then return list of objects containing a collection of CPEs.",
"parameters": {
"type": "object",
"properties": {
"cpeNameId": {
"type": "string",
"description": "Returns a specific CPE record using its UUID."
},
"cpeMatchString": {
"type": "string",
"description": "Use a partial CPE name to search for other CPE names."
},
"keywordExactMatch": {
"type": "boolean",
"description": "Searches metadata within CPE title and reference links for an exact match of the phrase or word passed to it."
},
"keywordSearch": {
"type": "string",
"description": "Returns CPE records where a word or phrase is found in the metadata title or reference links."
},
"lastModStartDate": {
"type": ["string", "object"],
"description": "CPE last modification start date."
},
"lastModEndDate": {
"type": ["string", "object"],
"description": "CPE last modification end date."
},
"limit": {
"type": "integer",
"description": "Limits the number of results of the search."
},
"key": {
"type": "string",
"description": "NVD API Key."
},
"delay": {
"type": "number",
"description": "The amount of time to sleep in between requests."
},
"verbose": {
"type": "boolean",
"description": "Prints the URL request for debugging purposes."
}
},
"required": ["cpeNameId"]
}
} | cvecpe |
vt_get_dns_resolution_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.",
"attributes": {
"date": {
"type": "integer",
"description": "Date when the resolution was made (UTC timestamp)"
},
"host_name": {
"type": "string",
"description": "Domain or subdomain requested to the resolver"
},
"host_name_last_analysis_stats": {
"type": "dictionary",
"description": "Last detection stats from the resolution\'s domain. Similar to the domains\'s last_analysis_stats attribute"
},
"ip_address": {
"type": "string",
"description": "IP address the domain was resolved to"
},
"ip_address_last_analysis_stats": {
"type": "dictionary",
"description": "Last detection stats from the resolution\'s IP address. Similar to the IP address\' last_analysis_stats attribute"
},
"resolver": {
"type": "string",
"description": "Source of the resolution"
}
},
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"required": true,
"description": "Resolution object ID"
},
"x-apikey": {
"type": "string",
"required": true,
"description": "Your API key"
},
}
}
} | virustotal |
vt_get_objects_related_to_ip_address | {
"name": "vt_get_objects_related_to_ip_address",
"description": "IP addresses have number of relationships to other objects. This returns ALL objects that fit the relationship.",
"relationships": [
"comments",
"communicating_files",
"downloaded_files",
"graphs",
"historical_ssl_certificates",
"historical_whois",
"related_comments",
"related_references",
"related_threat_actors",
"referrer_files",
"resolutions",
"urls"
],
"parameters": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address"
},
"relationship": {
"type": "string",
"description": "Relationship name (see the list of items from above)"
},
"x-apikey": {
"type": "string",
"description": "Your API key"
},
"limit": {
"type": "int32",
"description": "Maximum number of comments to retrieve",
"required": false
},
"cursor": {
"type": "string",
"description": "Continuation cursor",
"required": false
}
},
"required": ["ip", "relationship", "x-apikey"]
}
} | virustotal |
vt_get_ip_address_report | {
"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": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address"
},
"x-apikey": {
"type": "string",
"description": "Your API key"
}
},
"required": ["ip", "x-apikey"]
}
} | virustotal |
vt_add_votes_to_ip_address | {
"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. Please ensure that the JSON object you provide conforms accurately to valid JSON standards.",
"parameters": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address",
"required": true
},
"data": {
"type": "json",
"description": "Vote object"
},
"x-apikey": {
"type": "string",
"description": "Your API key",
"required": true
}
}
}
} | virustotal |
vt_get_domain_report | {
"name": "vt_get_domain_report",
"description": "Retrieves a domain report. These reports contain information regarding the domain itself that VirusTotal has collected.",
"parameters": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name",
},
"x-apikey": {
"type": "string",
"description": "Your API key",
},
},
"required": ["domain", "x-apikey"],
},
} | virustotal |
vt_get_comments_on_ip_address | {
"name": "vt_get_comments_on_ip_address",
"description": "Retrieves the comments on a provided IP address. Returns a list of Comment objects.",
"parameters": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address"
},
"x-apikey": {
"type": "string",
"description": "Your API key"
},
"limit": {
"type": "integer",
"description": "Maximum number of comments to retrieve",
"format": "int32"
},
"cursor": {
"type": "string",
"description": "Continuation cursor"
}
},
"required": ["ip", "x-apikey"]
}
} | virustotal |
vt_add_comment_to_ip_address | {
"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. However, please note that you will need to provide a valid data JSON for using this function. 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": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address",
"required": true
},
"data": {
"type": "json",
"description": "A comment object",
"required": true
},
"x-apikey": {
"type": "string",
"description": "Your API key",
"required": true
},
},
"required": ["ip", "data", "x-apikey"],
},
} | virustotal |
vt_get_object_descriptors_related_to_ip_address | {
"name": "vt_get_object_descriptors_related_to_ip_address",
"description": "This specifically returns related object\'s IDs (and context attributes, if any). Please note that this will not return all attributes. You are expected to provide the relationship to the object you\'re interested in.",
"parameters": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address",
"required": true
},
"relationship": {
"type": "string",
"description": "Relationship name (see table)",
"required": true
},
"x-apikey": {
"type": "string",
"description": "Your API key",
"required": true
},
"limit": {
"type": "integer",
"format": "int32",
"description": "Maximum number of comments to retrieve",
"required": false
},
"cursor": {
"type": "string",
"description": "Continuation cursor",
"required": false
},
},
"required": ["ip", "relationship", "x-apikey"],
},
"relationships": {
"comments": "The comments for the IP address.",
"communicating_files": "Files that communicate with the IP address.",
"downloaded_files": "Files downloaded from the IP address. VT Enterprise users only.",
"graphs": "Graphs including the IP address.",
"historical_ssl_certificates": "SSL certificates associated with the IP.",
"historical_whois": "WHOIS information for the IP address. Retrurns a list of Whois attributes.",
"related_comments": "Community posted comments in the IP\'s related objects.",
"related_references": "Returns the references related to the IP address.",
"related_threat_actors": "Threat actors related to the IP address.",
"referrer_files": "Files containing the IP address.",
"resolutions": "Resolves the IP addresses.",
"urls": "Returns a list of URLs related to the IP address."
}
} | virustotal |
vt_get_objects_related_to_domain | {
"name": "vt_get_objects_related_to_domain",
"description": "Objects are a key concept in the VirusTotal API. Each object has an identifier and a type. Each object has an associated URL, and each domain is associated with objects. This function returns ALL of the objects related to the domain, based on the specified relationship.",
"parameters": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"relationship": {
"type": "string",
"description": "Relationship name (see table)",
"enum": ["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", "user_votes"]
},
"x-apikey": {
"type": "string",
"description": "Your API key"
},
"limit": {
"type": "integer",
"description": "Maximum number of comments to retrieve"
},
"cursor": {
"type": "string",
"description": "Continuation cursor"
}
},
"required": ["domain", "relationship", "x-apikey"]
}
} | virustotal |
vt_get_object_descriptors_related_to_domain | {
"name": "vt_get_object_descriptors_related_to_domain",
"description": "This specifically returns related object\'s IDs (and context attributes, if any). This will return objects relating to a domain.",
"parameters": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name",
"required": true
},
"relationship": {
"type": "string",
"description": "Relationship name",
"required": true
},
"x-apikey": {
"type": "string",
"description": "Your API key",
"required": true
},
"limit": {
"type": "integer",
"description": "Maximum number of comments to retrieve",
"required": false
},
"cursor": {
"type": "string",
"description": "Continuation cursor",
"required": false
}
},
"required": ["domain", "relationship", "x-apikey"],
},
} | virustotal |
vt_get_comments_on_domain | {
"name": "vt_get_comments_on_domain",
"description": "This function will retrieve comments on a specified domain.",
"parameters": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"x-apikey": {
"type": "string",
"description": "Your API key"
},
"limit": {
"type": "int32",
"description": "Maximum number of comments to retrieve"
},
"cursor": {
"type": "string",
"description": "Continuation cursor"
}
},
"required": ["domain", "x-apikey"]
}
} | virustotal |
vt_get_votes_on_ip_address | {
"name": "vt_get_votes_on_ip_address",
"description": "This function will retrieve votes on a provided IP address.",
"parameters": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "ip address",
},
},
"required": ["ip"],
},
} | virustotal |