/cisa/ics-advisories

POST /api/cisa/ics-advisories

Price: 5 credits

Get a CISA industrial control systems advisory by its alert code

How to use it

Use this for the machine-readable ICS/OT advisory behind a code such as ICSA-26-244-06: the affected vendor products and versions, the CVEs with their CWE and CVSS scores, and the vendor's remediation text. Pass the code in any case, or the cisa.gov advisory URL. Codes beginning ics-alert- are the legacy alert series and resolve from the web page instead, so they carry the advisory body as text and no per-product breakdown.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• alert_code string required — ICS advisory alert code, or a cisa.gov advisory URL containing it (examples: "icsa-26-244-06", "ICSMA-26-225-01", "ics-alert-20-217-01"; minLength: 1)

Response

• @type string (default: "CisaIcsAdvisory")
• id string required
• name string nullable
• description string nullable
• web_url string nullable
• csaf_url string nullable
• advisory_type string nullable
• release_date string nullable
• updated_date string nullable
• tracking_version string nullable
• tracking_status string nullable
• category string nullable
• csaf_version string nullable
• language string nullable
• tlp_label string nullable
• distribution_text string nullable
• publisher_name string nullable
• publisher_category string nullable
• publisher_namespace string nullable
• publisher_contact_details string nullable
• aliases array (default: [])
• cve_ids array (default: [])
• notes array (default: [])
  • @type string (default: "CisaCsafNote")
  • category string nullable
  • name string nullable
  • text string nullable
  • audience string nullable
• references array (default: [])
  • @type string (default: "CisaCsafReference")
  • category string nullable
  • summary string nullable
  • url string nullable
• acknowledgments array (default: [])
  • @type string (default: "CisaCsafAcknowledgment")
  • names array (default: [])
  • organization string nullable
  • summary string nullable
  • urls array (default: [])
• revisions array (default: [])
  • @type string (default: "CisaCsafRevision")
  • number string nullable
  • date string nullable
  • legacy_version string nullable
  • summary string nullable
• products array (default: [])
  • @type string (default: "CisaCsafProduct")
  • product_id string required
  • name string nullable
  • vendor string nullable
  • product_family string nullable
  • version string nullable
  • cpe string nullable
  • model_numbers array (default: [])
  • serial_numbers array (default: [])
  • skus array (default: [])
  • generic_uris array (default: [])
    • @type string (default: "CisaCsafGenericUri")
    • namespace string nullable
    • uri string nullable
• vulnerabilities array (default: [])
  • @type string (default: "CisaCsafVulnerability")
  • cve_id string nullable
  • name string nullable
  • cwe_id string nullable
  • cwe_name string nullable
  • affected_product_ids array (default: [])
  • notes array (default: [])
    • @type string (default: "CisaCsafNote")
    • category string nullable
    • name string nullable
    • text string nullable
    • audience string nullable
  • references array (default: [])
    • @type string (default: "CisaCsafReference")
    • category string nullable
    • summary string nullable
    • url string nullable
  • remediations array (default: [])
    • @type string (default: "CisaCsafRemediation")
    • category string nullable
    • details string nullable
    • url string nullable
    • product_ids array (default: [])
    • group_ids array (default: [])
  • scores array (default: [])
    • @type string (default: "CisaCsafScore")
    • version string nullable
    • base_score number nullable
    • base_severity string nullable
    • vector_string string nullable
    • temporal_score number nullable
    • temporal_severity string nullable
    • environmental_score number nullable
    • environmental_severity string nullable
    • product_ids array (default: [])
• text string nullable
• tags array (default: [])
  • @type string (default: "CisaAdvisoryTag")
  • name string required
  • values array (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 — CISA publishes no ICS advisory under that alert code. 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.