/mitre_attack/techniques/search

POST /api/mitre_attack/techniques/search

Price: 20 credits

Search MITRE ATT&CK techniques by text, tactic, platform and matrix

How to use it

Use this to turn a described behaviour into ATT&CK ids, or to enumerate a matrix. query is a literal substring match over the technique name and description, so prefer ATT&CK's own vocabulary ('credential dumping') over a paraphrase. Sub-techniques come back alongside their parents unless is_subtechnique separates them, and omitting domain searches Enterprise, Mobile and ICS together.

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 technique name and its description (examples: "process injection", "phishing")
• domain string nullable — ATT&CK matrix to search, or every matrix when omitted (one of: "enterprise", "mobile", "ics")
• tactic string nullable — Tactic the technique serves, by ATT&CK id or by its shortname (examples: "TA0002", "privilege-escalation")
• platform string nullable — Platform the technique applies to (examples: "Windows", "Containers")
• is_subtechnique boolean nullable — Restrict to sub-techniques, or to parent techniques only
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "MitreAttackTechnique")
• 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
• is_subtechnique boolean (default: false)
• parent_technique_id string nullable
• tactic_shortnames array (default: [])
• tactic_ids array (default: [])
• platforms array (default: [])
• tactic_types array (default: [])
• impact_types array (default: [])
• has_remote_support boolean nullable
• targeted_asset_ids array (default: [])
• detection_strategy_ids array (default: [])

Errors

• 422 — tactic or platform does not match any value ATT&CK records for the searched matrix. 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.