Red Hat SummitChapter 2. CSAF
2.1. List all CSAFs
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
GET /csaf.json
GET /csaf.json
XML
GET /csaf.xml
GET /csaf.xml
HTML
GET /csaf
GET /csaf2.2. Parameters
| Name | Description | Example |
|---|---|---|
| before | Index of CSAF documents before the query date. [ISO 8601 is the expected format] | 2016-03-01 |
| after | Index of CSAF documents after the query date. [ISO 8601 is the expected format] | 2016-02-01 |
| 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 |
| isCompressed | Return response in compressed 'gzip' format | Default: true |
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.
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.All the above query parameters can be used in combination with each other to retrieve the desired result.
2.3. Retrieve a CSAF
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.
GET /csaf/<RHSA_ID>.json
GET /csaf/<RHSA_ID>.json
XML
GET /csaf/<RHSA_ID>.xml
GET /csaf/<RHSA_ID>.xml
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/csaf
https://access.redhat.com/hydra/rest/securitydata/csaf.xml
https://access.redhat.com/hydra/rest/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
https://access.redhat.com/hydra/rest/securitydata/csaf?isCompressed=false
https://access.redhat.com/hydra/rest/securitydata/csaf.json?isCompressed=false
https://access.redhat.com/hydra/rest/securitydata/csaf.json?after=2022-11-30&isCompressed=false
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}