GET /katello/api/content_view_versions
List content view versions

GET /katello/api/content_views/:content_view_id/content_view_versions
List content view versions

Params

Param Name Description
content_view_id
Optional

Content view identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

environment_id
Optional

Filter versions by environment

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

puppet_module_id
Optional

Filter versions by puppet module

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

version
Optional

Filter versions by version number

Validations:

  • String

composite_version_id
Optional

Filter versions that are components in the specified composite version

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

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_results
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/content_view_versions/:id
Show content view version

Params

Param Name Description
id
Required

Content view version identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /katello/api/content_view_versions/:id/promote
Promote a content view version

Params

Param Name Description
id
Required

Content view version identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

force
Optional

force content view promotion and bypass lifecycle environment restriction

Validations:

  • boolean

environment_id
Optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /katello/api/content_view_versions/:id/export
Export a content view version

Params

Param Name Description
id
Required

Content view version identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

export_to_iso
Optional

Export to ISO format

Validations:

  • boolean

iso_mb_size
Optional

maximum size of each ISO in MB

Validations:

  • number.

since
Optional

Optional date of last export (ex: 2010-01-01T12:00:00Z)

Validations:

  • Date


DELETE /katello/api/content_view_versions/:id
Remove content view version

Params

Param Name Description
id
Required

Content view version identifier

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /katello/api/content_view_versions/incremental_update
Perform an Incremental Update on one or more Content View Versions

Params

Param Name Description
content_view_version_environments
Optional

Validations:

  • Must be an Array of nested elements

content_view_version_environments[content_view_version_id]
Optional

Content View Version Ids to perform an incremental update on. May contain composites as well as one or more components to update.

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_version_environments[environment_ids]
Optional

The list of environments to promote the specified Content View Version to (replacing the older version).

Validations:

  • Must be an array of any type

description
Optional

The description for the new generated Content View Versions

Validations:

  • String

resolve_dependencies
Optional

If true, when adding the specified errata or packages, any needed dependencies will be copied as well.

Validations:

  • boolean

propagate_all_composites
Optional

If true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment.

Validations:

  • boolean

add_content
Optional

Validations:

  • Hash

add_content[errata_ids]
Optional

Errata ids or uuids to copy into the new versions.

Validations:

  • Must be an array of any type

add_content[package_ids]
Optional

Package ids or uuids to copy into the new versions.

Validations:

  • Must be an array of any type

add_content[puppet_module_ids]
Optional

Puppet Module ids or uuids to copy into the new versions.

Validations:

  • Must be an array of any type

update_hosts
Optional

After generating the incremental update, apply the changes to the specified hosts. Only Errata are supported currently.

Validations:

  • Hash

update_hosts[included]
Required

Validations:

  • Hash

update_hosts[included][search]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Search string for host to perform an action on

Validations:

  • String

update_hosts[included][ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

List of host ids to perform an action on

Validations:

  • Must be an array of any type

update_hosts[excluded]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Hash

update_hosts[excluded][ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

List of host ids to exclude and not run an action on

Validations:

  • Must be an array of any type