Content views

>>>

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

GET /katello/api/content_views
List content views

Examples

GET /katello/api/organizations/114267492/content_views
204

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
label
optional

Label of the content view

Validations:

  • String
include_generated
optional

Include content views generated by imports/exports. Defaults to false

Validations:

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

Examples

POST /katello/api/organizations/114267492/content_views
{
  "name": "My View",
  "label": "My_View",
  "description": "Cool",
  "solve_dependencies": true,
  "content_view": {
    "name": "My View",
    "label": "My_View",
    "description": "Cool",
    "solve_dependencies": true
  }
}
201
{
  "content_host_count": 0,
  "composite": false,
  "component_ids": [],
  "default": false,
  "version_count": 0,
  "latest_version": null,
  "latest_version_id": null,
  "auto_publish": false,
  "solve_dependencies": true,
  "import_only": false,
  "generated_for": "none",
  "related_cv_count": 0,
  "related_composite_cvs": [],
  "repository_ids": [],
  "id": 1058174850,
  "name": "My View",
  "label": "My_View",
  "description": "Cool",
  "organization_id": 114267492,
  "organization": {
    "name": "Empty Organization",
    "label": "Empty_Organization",
    "id": 114267492
  },
  "created_at": "2022-11-08 19:29:16 UTC",
  "updated_at": "2022-11-08 19:29:16 UTC",
  "last_task": null,
  "latest_version_environments": [],
  "repositories": [],
  "versions": [],
  "components": [],
  "content_view_components": [],
  "activation_keys": [],
  "hosts": [],
  "next_version": "1.0",
  "last_published": null,
  "environments": [],
  "duplicate_repositories_to_publish": [],
  "errors": null
}

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.
import_only
optional

Designate this Content View for importing from upstream servers only. Defaults to false

Validations:

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

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

Examples

PUT /katello/api/content_views/64601712
{
  "content_view": {
    "component_ids": [
      998596613,
      998596614
    ]
  }
}
422
{
  "displayMessage": "Validation failed: Base Another component already includes content view with ID 405955044",
  "errors": {
    "content_view_components.base": [
      "Another component already includes content view with ID 405955044"
    ]
  }
}

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.
import_only
optional

Designate this Content View for importing from upstream servers only. Defaults to false

Validations:

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

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

Examples

POST /katello/api/content_views/909058347/publish
{
  "minor": 1,
  "content_view": {}
}
400
{
  "displayMessage": "Both major and minor parameters have to be used to override a CV version",
  "errors": [
    "Both major and minor parameters have to be used to override a CV version"
  ]
}

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.
environment_ids
optional

Identifiers for Lifecycle Environment

Validations:

  • Must be an array of any type
is_force_promote
optional

force content view promotion and bypass lifecycle environment restriction

Validations:

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

Examples

GET /katello/api/content_views/419082953
200
{
  "content_host_count": 0,
  "composite": false,
  "component_ids": [],
  "default": false,
  "version_count": 1,
  "latest_version": "3.0",
  "latest_version_id": 234564707,
  "auto_publish": false,
  "solve_dependencies": false,
  "import_only": false,
  "generated_for": "none",
  "related_cv_count": 0,
  "related_composite_cvs": [],
  "repository_ids": [],
  "id": 419082953,
  "name": "Published Library - dev - staging view",
  "label": "published_dev_staging_view",
  "description": "A content view",
  "organization_id": 114267492,
  "organization": {
    "name": "Empty Organization",
    "label": "Empty_Organization",
    "id": 114267492
  },
  "created_at": "2022-11-08 19:09:32 UTC",
  "updated_at": "2022-11-08 19:09:32 UTC",
  "last_task": null,
  "latest_version_environments": [
    {
      "id": 562075838,
      "name": "Library",
      "label": "library_label"
    },
    {
      "id": 292811013,
      "name": "Dev",
      "label": "dev_label"
    },
    {
      "id": 1028819239,
      "name": "Staging",
      "label": "staging_label"
    }
  ],
  "repositories": [],
  "versions": [
    {
      "id": 234564707,
      "version": "3.0",
      "published": "2022-11-08 19:09:32 UTC",
      "environment_ids": [
        562075838,
        292811013,
        1028819239
      ]
    }
  ],
  "components": [],
  "content_view_components": [],
  "activation_keys": [
    {
      "id": 878475814,
      "name": "Lib Dev Stating Activation Key"
    }
  ],
  "hosts": [],
  "next_version": "4.0",
  "last_published": "2022-11-08 19:09:32 UTC",
  "environments": [
    {
      "id": 562075838,
      "label": "library_label",
      "name": "library_label",
      "activation_keys": [],
      "hosts": [],
      "permissions": {
        "readable": true
      }
    },
    {
      "id": 292811013,
      "label": "dev_label",
      "name": "dev_label",
      "activation_keys": [
        878475814
      ],
      "hosts": [],
      "permissions": {
        "readable": true
      }
    },
    {
      "id": 1028819239,
      "label": "staging_label",
      "name": "staging_label",
      "activation_keys": [],
      "hosts": [],
      "permissions": {
        "readable": true
      }
    }
  ],
  "duplicate_repositories_to_publish": [],
  "errors": null
}

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

Examples

DELETE /katello/api/content_views/909058347/environments/1028819239
{
  "content_view": {}
}
400
{
  "displayMessage": "Content view 'Published Library and dev view' is not in lifecycle environment 'Staging'.",
  "errors": [
    "Content view 'Published Library and dev view' is not in lifecycle environment 'Staging'."
  ]
}

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

Examples

PUT /katello/api/content_views/419082953/remove
{
  "environment_ids": [
    292811013
  ],
  "key_content_view_id": 419082953,
  "key_environment_id": 1028819239,
  "content_view": {}
}
204

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 an array of number
content_view_version_ids
optional

content view version identifiers to be deleted

Validations:

  • Must be an array of 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.
destroy_content_view
optional

delete the content view with all the versions and environments

Validations:

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

PUT /katello/api/content_views/:id/bulk_delete_versions
Bulk remove versions from a content view and reassign systems and keys

Examples

PUT /katello/api/content_views/419082953/bulk_delete_versions
{
  "key_content_view_id": 419082953,
  "key_environment_id": 562075838,
  "system_content_view_id": 419082953,
  "system_environment_id": 562075838,
  "bulk_content_view_version_ids": {
    "included": {
      "ids": [
        234564707
      ]
    }
  },
  "content_view": {}
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

Params

Param name Description
included
required

Versions to exclusively include in the action

Validations:

  • Hash
included[search]
optional , nil allowed

Search string for versions to perform an action on

Validations:

  • String
included[ids]
optional , nil allowed

List of versions to perform an action on

Validations:

  • Must be an array of any type
excluded
required

Versions to explicitly exclude in the action. All other versions will be included in the action, unless an included parameter is passed as well.

Validations:

  • Hash
excluded[ids]
optional , nil allowed

List of versions to exclude and not run an action on

Validations:

  • Must be an array of any type
id
required

content view numeric identifier

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.
>>>

PUT /katello/api/content_views/:id/remove_filters
Delete multiple filters from a content view

Examples

PUT /katello/api/content_views/1058174851/remove_filters
{
  "filter_ids": [
    703096855
  ],
  "content_view": {}
}
200
{
  "content_host_count": 0,
  "composite": false,
  "component_ids": [],
  "default": false,
  "version_count": 0,
  "latest_version": null,
  "latest_version_id": null,
  "auto_publish": false,
  "solve_dependencies": false,
  "import_only": false,
  "generated_for": "none",
  "related_cv_count": 0,
  "related_composite_cvs": [],
  "repository_ids": [],
  "id": 1058174851,
  "name": "Cat",
  "label": "Cat",
  "description": null,
  "organization_id": 114267492,
  "organization": {
    "name": "Empty Organization",
    "label": "Empty_Organization",
    "id": 114267492
  },
  "created_at": "2022-11-08 19:29:20 UTC",
  "updated_at": "2022-11-08 19:29:20 UTC",
  "last_task": null,
  "latest_version_environments": [],
  "repositories": [],
  "versions": [],
  "components": [],
  "content_view_components": [],
  "activation_keys": [],
  "hosts": [],
  "next_version": "1.0",
  "last_published": null,
  "environments": [],
  "duplicate_repositories_to_publish": [],
  "errors": null
}

Params

Param name Description
id
required

content view numeric identifier

Validations:

  • Must be a number.
filter_ids
required

filter identifiers

Validations:

  • Must be an array of number
>>>

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

Examples

DELETE /katello/api/content_views/1058174853
{
  "content_view": {}
}
202
{
  "id": "8fe1160e-c332-41db-bb7d-18a92821f7fc",
  "label": "Actions::Katello::ContentView::Destroy",
  "pending": false,
  "action": "Delete content view 'Cat'; organization 'Empty Organization'",
  "username": "secret_admin",
  "started_at": "2022-11-08 19:29:21 UTC",
  "ended_at": "2022-11-08 19:29:21 UTC",
  "state": "stopped",
  "result": "success",
  "progress": 1.0,
  "input": {
    "content_view": {
      "id": 1058174853,
      "name": "Cat",
      "label": "Cat"
    },
    "organization": {
      "id": 114267492,
      "name": "Empty Organization",
      "label": "Empty_Organization"
    },
    "services_checked": [
      "pulp3"
    ],
    "remote_user": "admin",
    "remote_cp_user": "admin"
  },
  "output": {},
  "humanized": {
    "action": "Delete",
    "input": [
      [
        "content_view",
        {
          "text": "content view 'Cat'",
          "link": "/content_views/1058174853/versions"
        }
      ],
      [
        "organization",
        {
          "text": "organization 'Empty Organization'",
          "link": "/organizations/114267492/edit"
        }
      ]
    ],
    "output": "",
    "errors": []
  },
  "cli_example": null,
  "start_at": "2022-11-08 19:29:21 UTC",
  "available_actions": {
    "cancellable": false,
    "resumable": false
  }
}

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

Examples

POST /katello/api/content_views/419082953/copy
{
  "name": "My New View",
  "content_view": {
    "name": "My New View"
  }
}
201
{
  "composite": false,
  "component_ids": [],
  "default": false,
  "version_count": 0,
  "latest_version": null,
  "latest_version_id": null,
  "auto_publish": false,
  "solve_dependencies": false,
  "import_only": false,
  "generated_for": "none",
  "related_cv_count": 0,
  "related_composite_cvs": [],
  "repository_ids": [],
  "id": 1058174852,
  "name": "My New View",
  "label": "My_New_View",
  "description": "A content view",
  "organization_id": 114267492,
  "organization": {
    "name": "Empty Organization",
    "label": "Empty_Organization",
    "id": 114267492
  },
  "created_at": "2022-11-08 19:29:21 UTC",
  "updated_at": "2022-11-08 19:29:21 UTC",
  "last_task": null,
  "latest_version_environments": [],
  "repositories": [],
  "versions": [],
  "components": [],
  "content_view_components": [],
  "activation_keys": [],
  "hosts": [],
  "next_version": "1.0",
  "last_published": null,
  "environments": []
}

Params

Param name Description
id
required

Content view numeric identifier

Validations:

  • Must be a number.
name
required

New content view name

Validations:

  • String