Chapter 2. CSAF | Red Hat Product Documentation

#Omnivore

Read on Omnivore
Read Original

---

Chapter 2. CSAF

Abstract

Provides an index to all recent CSAF documents with a summary of their contents, when no parameter is passed. Returns a convenience object as the response with minimal attributes.

See the Explaining Red Hat Errata article for more information on Red Hat Errata (RHSA, RHBA, and RHEA).

JSON

Copied!

XML

Copied!

HTML

Copied!

2.2. Parameters

Copy link

Name	Description	Example
before	Index of CSAF documents before the query date. [ISO 8601 is the expected format]
after	Index of CSAF documents after the query date. [ISO 8601 is the expected format]
rhsa_ids	Index of CSAF documents for RHSA_IDs separated by comma	RHSA-2018:2748,RHSA-2018:2791
bug	Index of CSAF documents for Bugzilla Ids	1326598,1084875
cve	Index of CSAF documents for CVEs	CVE-2014-0160,CVE-2016-3990
severity	Index of CSAF documents for severity	low,moderate,important,critical
package	Index of CSAF documents which affect package	samba,thunderbird
page	Index of CSAF documents for page number	Default: 1
per_page	Number of index of CSAF documents to return per page	Default: 1000
created_days_ago	Index of CSAF documents created days ago	10

By default, search will return the first page of 1000 results, ordered by date. To change the page size use the ‘per_page’ param, and then iterate through pages using the ‘page’ param.

Copied!

All the above query parameters can be used in combination with each other to retrieve the desired result.

Abstract

CSAF details for the RHSA.

JSON

CSAF documents are in JSON format; the XML view is a representation of the CSAF data in XML format.

Copied!

XML

Copied!

Notes:

The JSON format for the Common Security Advisory Framework (CSAF) is defined by OASIS, see here for the GitHub repository and here for the schema.

For more information about the CSAF/VEX data provided by Red Hat see: https://www.redhat.com/en/blog/csaf-vex-documents-now-generally-available

Sample Query URLs

https://access.redhat.com/hydra/rest/securitydata/securitydata/csaf
https://access.redhat.com/hydra/rest/securitydata/securitydata/csaf.xml
https://access.redhat.com/hydra/rest/securitydata/securitydata/csaf.json

https://access.redhat.com/hydra/rest/securitydata/csaf.json?after=2023-09-01
https://access.redhat.com/hydra/rest/securitydata/csaf.json?created_days_ago=10
https://access.redhat.com/hydra/rest/securitydata/csaf.json?cve=CVE-2023-1829,CVE-2023-3090,CVE-2023-3390
https://access.redhat.com/hydra/rest/securitydata/csaf.json?rhsa_ids=RHSA-2022:6155,RHSA-2023:2378
https://access.redhat.com/hydra/rest/securitydata/csaf.json?bug=2053532,2153399
https://access.redhat.com/hydra/rest/securitydata/csaf.json?severity=important&created_days_ago=30
https://access.redhat.com/hydra/rest/securitydata/csaf.json?package=thunderbird

https://access.redhat.com/hydra/rest/securitydata/csaf/RHSA-2022:6155
https://access.redhat.com/hydra/rest/securitydata/csaf/RHSA-2022:6155.xml
https://access.redhat.com/hydra/rest/securitydata/csaf/RHSA-2022:6155.json