/alienvault_otx/pulses/search

POST /api/alienvault_otx/pulses/search

Price: 1 credit

Search AlienVault OTX pulses (community threat reports) by keyword

How to use it

Search AlienVault OTX for pulses — community-authored threat reports — by keyword (malware name, campaign, adversary, domain, hash, etc.), or list the newest pulses with an empty query. Order by most recently modified/created, oldest, most subscribers, or most indicators. Each result carries the pulse metadata: name, description, author, timestamps, tags, references, TLP, adversary, targeted countries, malware families, MITRE ATT&CK ids, industries, indicator-type breakdown and engagement counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Free-text query matched against pulse name, description, tags and indicators (minLength: 1)
• sort string — Ordering of the results (default: "-modified"; one of: "-modified", "modified", "-created", "created", "-subscriber_count", "-indicator_count")
• include_inactive boolean — Include pulses whose indicators are all expired/inactive (default: true)
• count integer required — Max number of pulses to return (min: 1)

Response

• @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: "")

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 — The entity was not found, or a precondition failed 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.