Products

>>>

GET /katello/api/products
List products

GET /katello/api/subscriptions/:subscription_id/products
List of subscription products in a subscription

GET /katello/api/activation_keys/:activation_key_id/products
List of subscription products in an activation key

GET /katello/api/organizations/:organization_id/products
List of products in an organization

GET /katello/api/sync_plans/:sync_plan_id/products
List of Products for sync plan

GET /katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products
List of Products for sync plan

Params

Param name Description
organization_id
required

Filter products by organization

Validations:

  • Must be a number.
subscription_id
optional

Filter products by subscription

Validations:

  • Must be a number.
name
optional

Filter products by name

Validations:

  • String
enabled
optional

Return enabled products only

Validations:

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

Return custom products only

Validations:

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

Return Red Hat (non-custom) products only

Validations:

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

Whether to include available content attribute in results

Validations:

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

Filter products by sync plan id

Validations:

  • Must be a number.
available_for
optional

Interpret specified object to return only Products that can be associated with specified object. Only 'sync_plan' is supported.

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
description text
label string
name string
organization_id integer
redhat true, false
>>>

POST /katello/api/products
Create a product

Params

Param name Description
organization_id
required

ID of the organization

Validations:

  • Must be a number.
description
optional

Product description

Validations:

  • String
gpg_key_id
optional

Identifier of the GPG key

Validations:

  • Must be a number.
ssl_ca_cert_id
optional

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.
ssl_client_cert_id
optional

Identifier of the SSL Client Cert

Validations:

  • Must be a number.
ssl_client_key_id
optional

Identifier of the SSL Client Key

Validations:

  • Must be a number.
sync_plan_id
optional , nil allowed

Plan numeric identifier

Validations:

  • Must be a number.
name
required

Product name

Validations:

  • String
label
optional

Validations:

  • String
>>>

GET /katello/api/products/:id
Show a product

Params

Param name Description
organization_id
optional

Organization ID

Validations:

  • Must be a number.
id
required

product numeric identifier

Validations:

  • Must be a number.
>>>

PUT /katello/api/products/:id
Updates a product

Params

Param name Description
id
required

product numeric identifier

Validations:

  • Must be a number.
description
optional

Product description

Validations:

  • String
gpg_key_id
optional

Identifier of the GPG key

Validations:

  • Must be a number.
ssl_ca_cert_id
optional

Idenifier of the SSL CA Cert

Validations:

  • Must be a number.
ssl_client_cert_id
optional

Identifier of the SSL Client Cert

Validations:

  • Must be a number.
ssl_client_key_id
optional

Identifier of the SSL Client Key

Validations:

  • Must be a number.
sync_plan_id
optional , nil allowed

Plan numeric identifier

Validations:

  • Must be a number.
name
optional

Product name

Validations:

  • String
>>>

DELETE /katello/api/products/:id
Destroy a product

Params

Param name Description
id
optional

product numeric identifier

Validations:

  • Must be a number.
>>>

POST /katello/api/products/:id/sync
Sync all repositories for a product

Params

Param name Description
id
required

product ID

Validations:

  • Must be a number.