Host errata

>>>

GET /api/hosts/:host_id/errata
List errata available for the content host

Examples

GET /api/hosts/692292738/errata
200
{
  "total": 0,
  "subtotal": 0,
  "selectable": 0,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "updated",
    "order": "desc"
  },
  "results": []
}

Params

Param name Description
host_id
required

UUID of the content host

Validations:

  • Must be a number.
content_view_id
optional

Calculate Applicable Errata based on a particular Content View

Validations:

  • Must be a number.
environment_id
optional

Calculate Applicable Errata based on a particular Environment

Validations:

  • Must be a number.
include_applicable
optional

Return errata that are applicable to this host. Defaults to false)

Validations:

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

Return only errata of a particular type (security, bugfix, enhancement)

Validations:

  • String
severity
optional

Return only errata of a particular severity (None, Low, Moderate, Important, Critical)

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
>>>

PUT /api/hosts/:host_id/errata/apply DEPRECATED
Schedule errata for installation using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead.

Examples

PUT /api/hosts/980190962/errata/apply
{
  "errata_ids": [
    "RHSA-1999-1231"
  ],
  "host_erratum": {
    "errata_ids": [
      "RHSA-1999-1231"
    ]
  }
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

Params

Param name Description
host_id
required

Host ID

Validations:

  • Must be a number.
errata_ids
required

List of Errata ids to install. Will be removed in a future release

Validations:

  • Must be an array of any type
included
required

Errata to exclusively include in the action

Validations:

  • Hash
included[search]
optional , nil allowed

Search string for erratum to perform an action on

Validations:

  • String
included[ids]
optional , nil allowed

List of errata ids to perform an action on, (ex: RHSA-2019:1168)

Validations:

  • Must be an array of any type
excluded
required

Errata to explicitly exclude in the action. All other applicable errata will be included in the action, unless an included parameter is passed as well.

Validations:

  • Hash
excluded[ids]
optional , nil allowed

List of errata ids to exclude and not run an action on, (ex: RHSA-2019:1168)

Validations:

  • Must be an array of any type
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
>>>

GET /api/hosts/:host_id/errata/:id
Retrieve a single errata for a host

Params

Param name Description
host_id
required

Host ID

Validations:

  • Must be a number.
id
required

Errata id of the erratum (RHSA-2012:108)

Validations:

  • String
>>>

PUT /api/hosts/:host_id/errata/applicability
Force regenerate applicability.

Examples

PUT /api/hosts/980190962/errata/applicability
{
  "host_erratum": {}
}
202
[

]

Params

Param name Description
host_id
required

Host ID

Validations:

  • Must be a number.