/mitre_attack/campaigns/search

POST /api/mitre_attack/campaigns/search

Price: 20 credits

Search MITRE ATT&CK campaigns by text, activity window and matrix

How to use it

Use this to find named intrusion campaigns, including by the window they were active in. The date filters read ATT&CK's first_seen and last_seen, which come from the reporting it cites rather than from continuous observation, so treat them as the span the public record covers. query also matches the campaign's aliases.

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 match against the campaign name, its aliases and its description (examples: "Dream Job", "SolarWinds")
• domain string nullable — ATT&CK matrix to search, or every matrix when omitted (one of: "enterprise", "mobile", "ics")
• first_seen_from string nullable — Only campaigns first seen on or after this date (examples: "2020-01-01")
• first_seen_to string nullable — Only campaigns first seen on or before this date (examples: "2022-12-31")
• last_seen_from string nullable — Only campaigns last seen on or after this date (examples: "2021-01-01")
• last_seen_to string nullable — Only campaigns last seen on or before this date (examples: "2023-12-31")
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "MitreAttackCampaign")
• id string required
• stix_id string nullable
• name string nullable
• description string nullable
• web_url string nullable
• domains array (default: [])
• version string nullable
• created_at string nullable
• modified_at string nullable
• contributors array (default: [])
• references array (default: [])
  • @type string (default: "MitreAttackReference")
  • source_name string nullable
  • description string nullable
  • url string nullable
• aliases array (default: [])
• first_seen_at string nullable
• last_seen_at string nullable
• first_seen_citation string nullable
• last_seen_citation string nullable
• attributed_to_group_ids array (default: [])

Errors

• 422 — a date filter is not in the YYYY-MM-DD form. 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.