Packages

>>>

GET /katello/api/packages
List packages

GET /katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id
List :resource_id

GET /katello/api/content_view_filters/:content_view_filter_id/:resource_id
List :resource_id

GET /katello/api/repositories/:repository_id/:resource_id
List :resource_id

Examples

GET /katello/api/packages
200
{
  "total": 5,
  "subtotal": 5,
  "selectable": 5,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 1037874757,
      "pulp_id": "modular",
      "name": "modular",
      "version": "0.9",
      "release": "108",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": true,
      "filename": "mod-99-108.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "modular-0.9-108.x86_64",
      "nvra": "mod-99-108.x86_64",
      "uuid": "modular",
      "hosts_available_count": 0,
      "hosts_applicable_count": 0
    },
    {
      "id": 980190962,
      "pulp_id": "one-uuid",
      "name": "one",
      "version": "1.0",
      "release": "1.el7",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "one-1.1.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "one-1.0-1.el7.x86_64",
      "nvra": "one-1.0-1.el7.x86_64",
      "uuid": "one-uuid",
      "hosts_available_count": 0,
      "hosts_applicable_count": 1
    },
    {
      "id": 1046165992,
      "pulp_id": "one-uuid-two",
      "name": "one",
      "version": "1.0",
      "release": "2.el7",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "one-1.2.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "one-1.0-2.el7.x86_64",
      "nvra": "one-1.0-2.el7.x86_64",
      "uuid": "one-uuid-two",
      "hosts_available_count": 0,
      "hosts_applicable_count": 0
    },
    {
      "id": 113629430,
      "pulp_id": "three-uuid",
      "name": "three",
      "version": "99",
      "release": "108",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "three-99-108.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "three-99-108.x86_64",
      "nvra": "three-99-108.x86_64",
      "uuid": "three-uuid",
      "hosts_available_count": 0,
      "hosts_applicable_count": 0
    },
    {
      "id": 298486374,
      "pulp_id": "two-uuid",
      "name": "two",
      "version": "1.0",
      "release": "1.el7",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "two-2.1.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "two-1.0-1.el7.x86_64",
      "nvra": "two-1.0-1.el7.x86_64",
      "uuid": "two-uuid",
      "hosts_available_count": 0,
      "hosts_applicable_count": 1
    }
  ]
}

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.
ids
optional

Package identifiers to filter content by

Validations:

  • Must be an array of any type
host_id
optional

Host id to list applicable packages for

Validations:

  • Must be a number.
packages_restrict_applicable
optional

Return packages 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.
packages_restrict_upgradable
optional

Return packages that are upgradable on one or more hosts

Validations:

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

Return only the latest version of each package

Validations:

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

Return packages that can be added to the specified object. Only the value 'content_view_version' is 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
>>>

GET /katello/api/packages/:id
Show a package

GET /katello/api/repositories/:repository_id/packages/:id
Show a package

Examples

GET /katello/api/repositories/920815232/packages/3805853f-5cae-4a4a-8549-0ec86410f58f
404
{
  "displayMessage": "Failed to find Package with id '3805853f-5cae-4a4a-8549-0ec86410f58f'.",
  "errors": [
    "Failed to find Package with id '3805853f-5cae-4a4a-8549-0ec86410f58f'."
  ]
}

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

Validations:

  • String
>>>

GET /katello/api/packages/compare
List packages

Examples

GET /katello/api/packages/compare
200
{
  "total": 5,
  "subtotal": 5,
  "selectable": 5,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 1037874757,
      "pulp_id": "modular",
      "name": "modular",
      "version": "0.9",
      "release": "108",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": true,
      "filename": "mod-99-108.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "modular-0.9-108.x86_64",
      "nvra": "mod-99-108.x86_64",
      "uuid": "modular",
      "hosts_available_count": 0,
      "hosts_applicable_count": 0,
      "comparison": [
        840492357
      ]
    },
    {
      "id": 980190962,
      "pulp_id": "one-uuid",
      "name": "one",
      "version": "1.0",
      "release": "1.el7",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "one-1.1.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "one-1.0-1.el7.x86_64",
      "nvra": "one-1.0-1.el7.x86_64",
      "uuid": "one-uuid",
      "hosts_available_count": 0,
      "hosts_applicable_count": 1,
      "comparison": [
        840492357
      ]
    },
    {
      "id": 1046165992,
      "pulp_id": "one-uuid-two",
      "name": "one",
      "version": "1.0",
      "release": "2.el7",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "one-1.2.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "one-1.0-2.el7.x86_64",
      "nvra": "one-1.0-2.el7.x86_64",
      "uuid": "one-uuid-two",
      "hosts_available_count": 0,
      "hosts_applicable_count": 0,
      "comparison": [
        840492357
      ]
    },
    {
      "id": 113629430,
      "pulp_id": "three-uuid",
      "name": "three",
      "version": "99",
      "release": "108",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "three-99-108.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "three-99-108.x86_64",
      "nvra": "three-99-108.x86_64",
      "uuid": "three-uuid",
      "hosts_available_count": 0,
      "hosts_applicable_count": 0,
      "comparison": [
        840492357
      ]
    },
    {
      "id": 298486374,
      "pulp_id": "two-uuid",
      "name": "two",
      "version": "1.0",
      "release": "1.el7",
      "arch": "x86_64",
      "epoch": "0",
      "summary": null,
      "modular": false,
      "filename": "two-2.1.rpm",
      "sourcerpm": null,
      "checksum": null,
      "nvrea": "two-1.0-1.el7.x86_64",
      "nvra": "two-1.0-1.el7.x86_64",
      "uuid": "two-uuid",
      "hosts_available_count": 0,
      "hosts_applicable_count": 1,
      "comparison": [
        840492357,
        531274492
      ]
    }
  ]
}

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