Content view versions

>>>

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:

  • Must be a number.
environment_id
optional

Filter versions by environment

Validations:

  • Must be a number.
puppet_module_id
optional

Filter versions by puppet module

Validations:

  • Must be a number.
version
optional

Filter versions by version number

Validations:

  • String
composite_version_id
optional

Filter versions that are components in the specified composite version

Validations:

  • Must be a number.
organization_id
optional

Organization identifier

Validations:

  • Must be a number.
triggered_by_id
optional

Filter composite versions whose publish was triggered by the specified component version

Validations:

  • Must be a number.
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
content_view_id integer
repository string
version string
>>>

GET /katello/api/content_view_versions/:id
Show content view version

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
>>>

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

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
force
optional

force content view promotion and bypass lifecycle environment restriction

Validations:

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

Identifiers for Lifecycle Environment

Validations:

  • Must be an array of any type
description
optional

The description for the content view version promotion

Validations:

  • String
>>>

PUT /katello/api/content_view_versions/:id
Update a content view version

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
description
required

The description for the content view version

Validations:

  • String
>>>

PUT /katello/api/content_view_versions/:id/republish_repositories
Forces a republish of the version's repositories' metadata

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
>>>

POST /katello/api/content_view_versions/:id/export
Export a content view version. Relevant only for Pulp 2 repositories.

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
export_to_iso
optional

Export to ISO format.

Validations:

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

maximum size of each ISO in MB. Relevant only for Pulp 2 repositories

Validations:

  • Must be a number.
since
optional

Optional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for Pulp 2 repositories

Validations:

  • Date
>>>

POST /katello/api/content_view_versions/import
Import a content view version

Params

Param name Description
content_view_id
required

Content view identifier

Validations:

  • Must be a number.
path
required

Directory containing the exported Content View Version

Validations:

  • String
metadata
required

Metadata taken from the upstream export history for this Content View Version

Validations:

  • Hash
>>>

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

Params

Param name Description
id
required

Content view version identifier

Validations:

  • Must be a number.
>>>

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:

  • Must be a number.
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. Defaults to true

Validations:

  • Must be one of: true, false, 1, 0.
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:

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

Validations:

  • Hash
add_content[errata_ids]
optional

Errata ids to copy into the new versions

Validations:

  • Must be an array of any type
add_content[package_ids]
optional

Package ids to copy into the new versions

Validations:

  • Must be an array of any type
add_content[deb_ids]
optional

Deb Package ids to copy into the new versions

Validations:

  • Must be an array of any type
add_content[puppet_module_ids]
optional

Puppet Module ids 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 , nil allowed

Search string for host to perform an action on

Validations:

  • String
update_hosts[included][ids]
optional , nil allowed

List of host ids to perform an action on

Validations:

  • Must be an array of any type
update_hosts[excluded]
optional , nil allowed

Validations:

  • Hash
update_hosts[excluded][ids]
optional , nil allowed

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

Validations:

  • Must be an array of any type