Host_packages

>>>

GET /api/hosts/:host_id/packages
List packages installed on the host

Examples

GET /api/hosts/980190962/packages
200
{
  "total": 2,
  "subtotal": 2,
  "selectable": 2,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 67,
      "name": "one",
      "nvrea": "one-1.0-1.el7.x86_64",
      "nvra": "one-1.0-1.el7.x86_64",
      "upgradable_versions": null,
      "rpm_id": null,
      "persistence": "transient"
    },
    {
      "id": 68,
      "name": "two",
      "nvrea": "two-1.0-1.el7.x86_64",
      "nvra": "two-1.0-1.el7.x86_64",
      "upgradable_versions": null,
      "rpm_id": null,
      "persistence": null
    }
  ]
}

Params

Param name Description
host_id
required

ID of the host

Validations:

  • Must be a number.
include_latest_upgradable
optional

Also include the latest upgradable package version for each host package

Validations:

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

Return only packages of a particular status (upgradable or up-to-date)

Validations:

  • String
persistence
optional

Return only packages of a particular persistence (transient, persistent, or nil)

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
arch string
epoch string
id integer
name string
nvra string
nvrea string
persistence transient, persistent
release string
vendor string
version string
>>>

GET /api/host_packages/:id
Show :a_resource

GET /api/repositories/:repository_id/host_packages/:id
Show :a_resource

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

:a_resource identifier

Validations:

  • String
>>>

GET /api/host_packages/compare
List :resource

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

GET /api/hosts/host_packages/installed_packages
Return a list of installed packages distinct by name

Examples

GET /api/hosts/host_packages/installed_packages
200
{
  "total": 2,
  "subtotal": 2,
  "selectable": 2,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "name": "one",
      "id": 61
    },
    {
      "name": "two",
      "id": 62
    }
  ]
}

Params

Param name Description
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/transient_packages/containerfile_install_command
Return a containerfile command to install transient packages

Examples

GET /api/hosts/980190962/transient_packages/containerfile_install_command
204

Params

Param name Description
host_id
required

ID of the host

Validations:

  • Must be a number.
include_unknown_persistence
optional

Include packages with unknown persistence in addition to transient packages

Validations:

  • Must be one of: true, false, 1, 0.
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
arch string
epoch string
id integer
name string
nvra string
nvrea string
persistence transient, persistent
release string
vendor string
version string