GET /katello/api/activation_keys
List activation keys

GET /katello/api/environments/:environment_id/activation_keys

GET /katello/api/organizations/:organization_id/activation_keys

Params

Param Name Description
organization_id
Required

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

content_view_id
Optional

content view identifier

Validations:

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

name
Optional

activation key name to filter by

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_results
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/activation_keys
Create an activation key

Params

Param Name Description
organization_id
Required

organization identifier

Validations:

  • number.

name
Required

name

Validations:

  • String

description
Optional

description

Validations:

  • String

environment
Optional

environment

Validations:

  • Hash

environment_id
Optional

id. d'entorn

Validations:

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

content_view_id
Optional

content view id

Validations:

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

max_hosts
Optional

maximum number of registered content hosts

Validations:

  • number.

unlimited_hosts
Optional

can the activation key have unlimited hosts

Validations:

  • boolean


PUT /katello/api/activation_keys/:id
Update an activation key

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

organization_id
Required

organization identifier

Validations:

  • number.

name
Optional

name

Validations:

  • String

description
Optional

description

Validations:

  • String

environment_id
Optional

id. d'entorn

Validations:

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

content_view_id
Optional

content view id

Validations:

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

max_hosts
Optional

maximum number of registered content hosts

Validations:

  • number.

unlimited_hosts
Optional

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
Optional

content release version

Validations:

  • String

service_level
Optional

service level

Validations:

  • String

auto_attach
Optional

auto attach subscriptions upon registration

Validations:

  • boolean


DELETE /katello/api/activation_keys/:id
Destroy an activation key

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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


GET /katello/api/activation_keys/:id
Show an activation key

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

organization_id
Optional

organization identifier

Validations:

  • number.


POST /katello/api/activation_keys/:id/copy
Copy an activation key

Params

Param Name Description
new_name
Required

Name of new activation key

Validations:

  • String

id
Required

ID of the activation key

Validations:

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

organization_id
Optional

organization identifier

Validations:

  • number.


GET /katello/api/activation_keys/:id/host_collections/available
List host collections the system does not belong to

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

name
Optional

host collection name to filter by

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
Show release versions available for an activation key

Params

Param Name Description
id
Required

ID of the activation key

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
Show content available for an activation key

Params

Param Name Description
id
Required

ID of the activation key

Validations:

  • String


POST /katello/api/activation_keys/:id/host_collections

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

host_collection_ids
Required

List of host collection IDs to associate with activation key

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/host_collections

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

host_collection_ids
Required

List of host collection IDs to disassociate from the activation key

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
Attach a subscription

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

subscription_id
Optional

Subscription identifier

Validations:

  • number.

quantity
Optional

Quantity of this subscription to add

Validations:

  • number.

subscriptions
Optional

Array of subscriptions to add

Validations:

  • Must be an Array of nested elements

subscriptions[id]
Optional

Subscription Pool uuid

Validations:

  • String

subscriptions[quantity]
Optional

Quantity of this subscriptions to add

Validations:

  • number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
Unattach a subscription

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

subscription_id
Optional

Subscription ID

Validations:

  • String

subscriptions
Optional

Array of subscriptions to add

Validations:

  • Must be an Array of nested elements

subscriptions[id]
Optional

Subscription Pool uuid

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
Override content for activation_key

Params

Param Name Description
id
Required

ID of the activation key

Validations:

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

content_override
Optional

Content override parameters

Validations:

  • Hash

content_override[content_label]
Required

Label of the content

Validations:

  • String

content_override[value]
Required

Override to 0/1, or 'default'

Validations:

  • Must be one of: 0, 1, default.