Errata

>>>

GET /katello/api/errata
List errata

Examples

GET /katello/api/errata
200
{
  "total": 1,
  "subtotal": 1,
  "selectable": 1,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "updated",
    "order": "desc"
  },
  "results": [
    {
      "id": 94098884,
      "pulp_id": "partylikeits1999",
      "title": "World is ending",
      "errata_id": "RHSA-1999-1231",
      "issued": "2022-11-05",
      "updated": "2022-11-05",
      "severity": "Critical",
      "description": null,
      "solution": null,
      "summary": null,
      "reboot_suggested": true,
      "uuid": "partylikeits1999",
      "name": "World is ending",
      "type": "security",
      "cves": [
        {
          "cve_id": "CVE-2223-0322",
          "href": "https://www.redhat.com/security/data/cve/CVE-2233-0322.html"
        }
      ],
      "bugs": [],
      "hosts_available_count": 0,
      "hosts_applicable_count": 0,
      "packages": [
        "foobar-1.2.3"
      ],
      "module_streams": []
    }
  ]
}

Params

Param name Description
organization_id
optional

Organization identifier

Validations:

  • Must be a number.
content_view_version_id
optional

Content View Version identifier

Validations:

  • Must be a number.
content_view_filter_id
optional

Content View Filter identifier

Validations:

  • Must be a number.
repository_id
optional

Repository identifier

Validations:

  • Must be a number.
environment_id
optional

Environment identifier

Validations:

  • Must be a number.
cve
optional

CVE identifier

Validations:

  • String
host_id
optional

Host id to list applicable errata for

Validations:

  • Must be a number.
errata_restrict_applicable
optional

Return errata that are applicable to one or more hosts (defaults to true if host_id is specified)

Validations:

  • Must be one of: true, false, 1, 0.
errata_restrict_installable
optional

Return errata that are upgradable on one or more hosts

Validations:

  • Must be one of: true, false, 1, 0.
available_for
optional

Return errata that can be added to the specified object. The values 'content_view_version' and 'content_view_filter are supported.

Validations:

  • String
search
optional

Search string

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.
order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String
full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.
sort_by
optional

Field to sort the results on

Validations:

  • String
sort_order
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String

Search fields

Field name Type Possible values
bug string
cve string
errata_id string
errata_type string
id string
issued date
modular true, false
package string
package_name string
reboot_suggested boolean
repository string
severity string
synopsis string
title string
type string
updated date
>>>

GET /katello/api/errata/:id
Show an erratum

GET /katello/api/repositories/:repository_id/errata/:id
Show an erratum

Examples

GET /katello/api/errata/not%20a%20real%20errata%20id
404
{
  "displayMessage": "Failed to find Erratum with id 'not a real errata id'.",
  "errors": [
    "Failed to find Erratum with id 'not a real errata id'."
  ]
}

Params

Param name Description
repository_id
optional

repository identifier

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
id
required

an erratum identifier

Validations:

  • String
>>>

GET /katello/api/errata/compare
List errata

Examples

GET /katello/api/errata/compare
200
{
  "total": 2,
  "subtotal": 2,
  "selectable": 2,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "updated",
    "order": "desc"
  },
  "results": [
    {
      "id": 94098884,
      "pulp_id": "partylikeits1999",
      "title": "World is ending",
      "errata_id": "RHSA-1999-1231",
      "issued": "2022-11-05",
      "updated": "2022-11-05",
      "severity": "Critical",
      "description": null,
      "solution": null,
      "summary": null,
      "reboot_suggested": true,
      "uuid": "partylikeits1999",
      "name": "World is ending",
      "type": "security",
      "cves": [
        {
          "cve_id": "CVE-2223-0322",
          "href": "https://www.redhat.com/security/data/cve/CVE-2233-0322.html"
        }
      ],
      "bugs": [],
      "hosts_available_count": 0,
      "hosts_applicable_count": 0,
      "packages": [
        "foobar-1.2.3"
      ],
      "module_streams": [],
      "comparison": [
        840492357,
        531274492
      ]
    },
    {
      "id": 92680584,
      "pulp_id": "100dividedby0",
      "title": "Divide by zero",
      "errata_id": "RHBA-2014-013",
      "issued": "2022-11-05",
      "updated": "2022-11-05",
      "severity": null,
      "description": null,
      "solution": null,
      "summary": null,
      "reboot_suggested": null,
      "uuid": "100dividedby0",
      "name": "Divide by zero",
      "type": "enhancement",
      "cves": [],
      "bugs": [],
      "hosts_available_count": 0,
      "hosts_applicable_count": 0,
      "packages": [],
      "module_streams": [],
      "comparison": [
        840492357
      ]
    }
  ]
}

Params

Param name Description
content_view_version_ids
optional

content view versions to compare

Validations:

  • Must be an array of any type
repository_id
optional

Library repository id to restrict comparisons to

Validations:

  • Must be a number.
restrict_comparison
optional

Return same, different or all results

Validations:

  • String