/alienvault_otx/pulses/indicators

POST /api/alienvault_otx/pulses/indicators

Price: 1 credit

List the indicators of compromise contained in an AlienVault OTX pulse

How to use it

List the indicators of compromise (IOCs) inside an AlienVault OTX pulse by its id. Returns each indicator's value and type (IP, domain, hostname, URL, file hash, CVE, …), the role/title/description assigned in the pulse, whether it is still active, its expiration time, and how many times it has been observed. Use this to export a pulse's full IOC feed.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• pulse string required — OTX pulse id (24-character hex) or a pulse URL (examples: "60ece5998a5b54a5ffe75cb4")
• sort string — Ordering of the indicators (default: "-created"; one of: "-created", "created")
• count integer required — Max number of indicators to return (min: 1)

Response

• @type string (default: "OtxPulseIndicator")
• id integer required
• indicator string required
• type string nullable
• alias string nullable
• role string nullable
• indicator_title string nullable
• description string nullable
• created_at integer nullable
• expiration_at integer nullable
• is_active boolean (default: false)
• observation_count integer (default: 0)

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 — Pulse 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.