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:

  • number.

environment_id
optional

environment identifier

Validations:

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

nondefault
optional

Filter out default content views

Validations:

  • boolean

noncomposite
optional

Filter out composite content views

Validations:

  • boolean

composite
optional

Filter only composite content views

Validations:

  • boolean

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:

  • 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


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:

  • number.

name
required

Name of the content view

Validations:

  • String

label
optional

Content view label

Validations:

  • String

composite
optional

Composite content view

Validations:

  • boolean

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


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

Params

Param name Description
id
required

Content view identifier

Validations:

  • 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


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

Params

Param name Description
id
required

Content view identifier

Validations:

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

description
optional

Description for the new published content view version

Validations:

  • String

force_yum_metadata_regeneration
optional

Force yum metadata regeneration on the repositories in the content view version

Validations:

  • boolean


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

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • 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:

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

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:

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


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:

  • number.

environment_id
required

environment numeric identifier

Validations:

  • 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:

  • number.

environment_ids
optional

environment numeric identifiers to be removed

Validations:

  • number.

content_view_version_ids
optional

content view version identifiers to be deleted

Validations:

  • number.

system_content_view_id
optional

content view to reassign orphaned systems to

Validations:

  • number.

system_environment_id
optional

environment to reassign orphaned systems to

Validations:

  • number.

key_content_view_id
optional

content view to reassign orphaned activation keys to

Validations:

  • number.

key_environment_id
optional

environment to reassign orphaned activation keys to

Validations:

  • number.


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

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • 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:

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

name
required

New content view name

Validations:

  • String