/alienvault_otx/indicators

POST /api/alienvault_otx/indicators

Price: 5 credits

Get an AlienVault OTX threat-intelligence indicator with its enrichment and related pulses

How to use it

Look up an AlienVault OTX (Open Threat Exchange) indicator of compromise by type and value — an IP (IPv4/IPv6), domain, hostname, URL, file hash (use type `file` for MD5/SHA1/SHA256) or CVE id. Returns the indicator's enrichment: geolocation and ASN (for IPs), a WHOIS reference (domains), reputation, false-positive and validation/whitelist assessments. For a CVE it returns the full vulnerability record — description, CVSS base score / severity / vector, CWE weakness id, EPSS exploit-prediction score, whether it is exploited in the wild, affected products (CPEs), known public exploits, advisory references, and the MITRE/NVD links. And — most importantly — the community pulses (threat reports) that reference this indicator with their tags, adversary, malware families and MITRE ATT&CK ids, plus the related adversaries, malware families and targeted industries.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• type string required — Indicator type. Use `file` for any file hash (MD5/SHA1/SHA256) and `url` for URL/URI. (one of: "IPv4", "IPv6", "domain", "hostname", "email", "url", "file", "cve")
• indicator string required — Indicator value to look up (IP, domain, hostname, URL, file hash or CVE id) (examples: "8.8.8.8", "google.com", "CVE-2021-44228"; minLength: 1)

Response

• @type string (default: "OtxIndicator")
• indicator string required
• type string nullable
• type_title string nullable
• base_indicator_id integer nullable
• reputation integer nullable
• asn string nullable
• whois_url string nullable
• alexa_url string nullable
• mitre_url string nullable
• nvd_url string nullable
• geo object nullable
  • @type string (default: "OtxGeo")
  • asn string nullable
  • city string nullable
  • region string nullable
  • subdivision string nullable
  • continent_code string nullable
  • country_code string nullable
  • country_code3 string nullable
  • country_name string nullable
  • latitude number nullable
  • longitude number nullable
  • postal_code string nullable
  • accuracy_radius integer nullable
  • dma_code integer nullable
  • area_code integer nullable
  • flag_url string nullable
  • flag_title string nullable
• validations array (default: [])
  • @type string (default: "OtxValidation")
  • source string nullable
  • name string nullable
  • message string nullable
• false_positives array (default: [])
  • @type string (default: "OtxFalsePositive")
  • assessment string nullable
  • assessment_date string nullable
  • report_date string nullable
• sections array (default: [])
• description string nullable
• cvss_score number nullable
• cvss_severity string nullable
• cvss_vector string nullable
• cwe string nullable
• epss number nullable
• is_seen_in_wild boolean (default: false)
• affected_products array (default: [])
• exploits array (default: [])
  • @type string (default: "OtxCveExploit")
  • name string required
  • url string nullable
  • source string nullable
  • exploit_type string nullable
  • author string nullable
  • platform string nullable
  • port string nullable
  • published_at integer nullable
• cve_references array (default: [])
• cve_published_at integer nullable
• cve_modified_at integer nullable
• pulse_count integer (default: 0)
• pulses array (default: [])
  • @type string (default: "OtxPulse")
  • id string required
  • name string required
  • description string nullable
  • author string nullable
  • author_id integer nullable
  • created_at integer nullable
  • modified_at integer nullable
  • tags array (default: [])
  • references array (default: [])
  • is_public boolean (default: false)
  • adversary string nullable
  • targeted_countries array (default: [])
  • malware_families array (default: [])
  • attack_ids array (default: [])
  • industries array (default: [])
  • groups array (default: [])
  • tlp string nullable
  • pulse_source string nullable
  • cloned_from string nullable
  • is_locked boolean (default: false)
  • indicator_count integer (default: 0)
  • indicator_type_counts object (default: {})
    • * integer
  • subscriber_count integer (default: 0)
  • comment_count integer (default: 0)
  • follower_count integer (default: 0)
  • vote_count integer (default: 0)
  • upvote_count integer (default: 0)
  • downvote_count integer (default: 0)
  • export_count integer (default: 0)
  • validator_count integer (default: 0)
  • web_url string (default: "")
• related_adversaries array (default: [])
• related_malware_families array (default: [])
• related_industries array (default: [])
• references array (default: [])
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Indicator not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.