GET /katello/api/package_groups
List package_groups

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

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

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

Params

Param name Description
organization_id
optional

organization identifier

Validations:

  • number.

content_view_version_id
optional

content view version identifier

Validations:

  • number.

content_view_filter_id
optional

content view filter identifier

Validations:

  • number.

repository_id
optional

repository identifier

Validations:

  • number.

environment_id
optional

environment identifier

Validations:

  • number.

ids
optional

ids to filter content by

Validations:

  • Must be an array of any type

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • number.

per_page
optional

Number of results per page to return

Validations:

  • number.

order
optional

Sort field and order, eg. ‘name DESC’

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • boolean

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

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/package_groups/:id
Show a package group

GET /katello/api/repositories/:repository_id/package_groups/:id
Show a package group

Params

Param name Description
repository_id
optional

repository identifier

Validations:

  • number.

id
required

a package group identifier

Validations:

  • String


GET /katello/api/compare
List package_groups

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:

  • number.


POST /katello/api/package_group
Create a package group

Params

Param name Description
repository_id
required

repository_id

Validations:

  • String

name
required

package group name.

Validations:

  • String

description
optional

package group description. Defaults to params[:name]

Validations:

  • String

user_visible
optional

set “user_visible” flag on package group. Defaults to true

Validations:

  • boolean

mandatory_package_names
optional

mandatory package names to include in the package group

Validations:

  • Must be an array of any type

optional_package_names
optional

optional package names to include in the package group

Validations:

  • Must be an array of any type

conditional_package_names
optional

conditional package names to include in the package group

Validations:

  • Must be an array of any type

default_package_names
optional

default package names to include in the package group

Validations:

  • Must be an array of any type


DELETE /katello/api/package_group
Delete a package group

Params

Param name Description
name
required

package group name

Validations:

  • String

repository_id
required

repository_id

Validations:

  • String