Subscriptions management.


GET /katello/api/organizations/:organization_id/subscriptions
List organization subscriptions

GET /katello/api/activation_keys/:activation_key_id/subscriptions
List an activation key's subscriptions

GET /katello/api/subscriptions

Params

Param name Description
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

organization_id
required

Organization ID

Validations:

  • number.

host_id
optional

id of a host

Validations:

  • String

activation_key_id
optional

Activation key ID

Validations:

  • String

available_for
optional

Object to show subscriptions available for, either ‘host’ or ‘activation_key’

Validations:

  • String

match_host
optional

Ignore subscriptions that are unavailable to the specified host

Validations:

  • boolean

match_installed
optional

Return subscriptions that match installed products of the specified host

Validations:

  • boolean

no_overlap
optional

Return subscriptions which do not overlap with a currently-attached subscription

Validations:

  • boolean


GET /katello/api/organizations/:organization_id/subscriptions/:id
Show a subscription

GET /katello/api/subscriptions/:id
Show a subscription

Params

Param name Description
organization_id
optional

Organization identifier

Validations:

  • number.

id
required

Subscription identifier

Validations:

  • number.


POST /katello/api/activation_keys/:activation_key_id/subscriptions DEPRECATED
Add a subscription to an activation key

Params

Param name Description
id
optional

Subscription Pool uuid

Validations:

  • String

activation_key_id
optional

ID of the activation key

Validations:

  • String

quantity
optional

Quantity of this subscriptions to add

Validations:

  • number.

subscriptions
optional

Array of subscriptions to add

Validations:

  • Must be an Array of nested elements

subscriptions[id]
required

Subscription Pool uuid

Validations:

  • String

subscriptions[quantity]
required

Quantity of this subscriptions to add

Validations:

  • number.


DELETE /katello/api/activation_keys/:activation_key_id/subscriptions/:id DEPRECATED
Unattach a subscription

Params

Param name Description
id
optional

Subscription ID

Validations:

  • String

activation_key_id
optional

activation key ID

Validations:

  • String


POST /katello/api/organizations/:organization_id/subscriptions/upload
Upload a subscription manifest

Params

Param name Description
organization_id
required

Organization id

Validations:

  • number.

content
required

Subscription manifest file

Validations:

  • File

repository_url
optional

repository url

Validations:

  • String


PUT /katello/api/organizations/:organization_id/subscriptions/refresh_manifest
Refresh previously imported manifest for Red Hat provider

Params

Param name Description
organization_id
required

Organization id

Validations:

  • number.


POST /katello/api/organizations/:organization_id/subscriptions/delete_manifest
Delete manifest from Red Hat provider

Params

Param name Description
organization_id
required

Organization id

Validations:

  • number.


GET /katello/api/organizations/:organization_id/subscriptions/manifest_history
obtain manifest history for subscriptions

Params

Param name Description
organization_id
required

Organization ID

Validations:

  • number.