Content views

>>>

GET /katello/api/organizations/:organization_id/content_views
List content views

GET /katello/api/content_views
List content views

Params

Param name Description
organization_id
optional

organization identifier

Validations:

  • Must be a number.
environment_id
optional

environment identifier

Validations:

  • Must be a number.
nondefault
optional

Filter out default content views

Validations:

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

Filter out composite content views

Validations:

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

Filter only composite content views

Validations:

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

Do not include this array of content views

Validations:

  • Must be an array of any type
name
optional

Name of the content view

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
composite boolean
label string
name string
organization_id integer
>>>

POST /katello/api/organizations/:organization_id/content_views
Create a content view

POST /katello/api/content_views
Create a content view

Params

Param name Description
organization_id
required

Organization identifier

Validations:

  • Must be a number.
name
required

Name of the content view

Validations:

  • String
label
optional

Content view label

Validations:

  • String
composite
optional

Composite content view

Validations:

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

Description for the content view

Validations:

  • String
repository_ids
optional

List of repository ids

Validations:

  • Must be an array of any type
component_ids
optional

List of component content view version ids for composite views

Validations:

  • Must be an array of any type
auto_publish
optional

Enable/Disable auto publish of composite view

Validations:

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

Solve RPM dependencies by default on Content View publish, defaults to false

Validations:

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

PUT /katello/api/content_views/:id
Update a content view

Params

Param name Description
id
required

Content view identifier

Validations:

  • Must be a number.
name
optional

New name for the content view

Validations:

  • String
description
optional

Description for the content view

Validations:

  • String
repository_ids
optional

List of repository ids

Validations:

  • Must be an array of any type
component_ids
optional

List of component content view version ids for composite views

Validations:

  • Must be an array of any type
auto_publish
optional

Enable/Disable auto publish of composite view

Validations:

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

Solve RPM dependencies by default on Content View publish, defaults to false

Validations:

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

POST /katello/api/content_views/:id/publish
Publish a content view

Params

Param name Description
id
required

Content view identifier

Validations:

  • Must be a number.
description
optional

Description for the new published content view version

Validations:

  • String
major
optional

Override the major version number

Validations:

  • Must be a number.
minor
optional

Override the minor version number

Validations:

  • Must be a number.
repos_units
optional

Specify the list of units in each repo

Validations:

  • Must be an Array of nested elements
repos_units[label]
required

repo label

Validations:

  • String
repos_units[rpm_filenames]
required

list of rpm filename strings to include in published version

Validations:

  • Must be an array of String
>>>

GET /katello/api/content_views/:id
Show a content view

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
>>>

GET /katello/api/content_views/:id/available_puppet_modules
Get puppet modules that are available to be added to the content view

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
name
optional

module name to restrict modules for

Validations:

  • String
>>>

GET /katello/api/content_views/:id/available_puppet_module_names
Get puppet modules names that are available to be added to the content view

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
>>>

DELETE /katello/api/content_views/:id/environments/:environment_id
Remove a content view from an environment

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
environment_id
required

environment numeric identifier

Validations:

  • Must be a number.
>>>

PUT /katello/api/content_views/:id/remove
Remove versions and/or environments from a content view and reassign systems and keys

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
environment_ids
optional

environment numeric identifiers to be removed

Validations:

  • Must be a number.
content_view_version_ids
optional

content view version identifiers to be deleted

Validations:

  • Must be a number.
system_content_view_id
optional

content view to reassign orphaned systems to

Validations:

  • Must be a number.
system_environment_id
optional

environment to reassign orphaned systems to

Validations:

  • Must be a number.
key_content_view_id
optional

content view to reassign orphaned activation keys to

Validations:

  • Must be a number.
key_environment_id
optional

environment to reassign orphaned activation keys to

Validations:

  • Must be a number.
>>>

DELETE /katello/api/content_views/:id
Delete a content view

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
>>>

POST /katello/api/content_views/:id/copy
Make copy of a content view

Params

Param name Description
id
required

Content view numeric identifier

Validations:

  • Must be a number.
name
required

New content view name

Validations:

  • String