GET /katello/api/organizations/114267492/activation_keys 200 { "total": 5, "subtotal": 5, "selectable": 5, "page": 1, "per_page": 20, "error": null, "search": null, "sort": { "by": "name", "order": "asc" }, "results": [ { "id": 757667888, "name": "Activation Key", "description": "A simple activation key.", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": "7Server", "purpose_usage": "usage name", "purpose_role": "role name", "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [ "Test Addon" ], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }, { "id": 939253911, "name": "And Yet Another Simple Activation Key", "description": "Here we go again!", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }, { "id": 734311356, "name": "Another Simple Activation Key", "description": "Another simple activation key.", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }, { "id": 568942081, "name": "Simple Activation Key", "description": "A simple activation key.", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }, { "id": 323709460, "name": "Yet Another Activation Key", "description": "And another simple activation key!", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } } ] }
Param name | Description |
---|---|
organization_id
required |
organization identifier Validations:
|
environment_id
optional |
environment identifier Validations:
|
content_view_id
optional |
content view identifier Validations:
|
name
optional |
activation key name to filter by Validations:
|
search
optional |
Search string Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return Validations:
|
order
optional |
Sort field and order, eg. 'id DESC' Validations:
|
full_result
optional |
Whether or not to show all results Validations:
|
sort_by
optional |
Field to sort the results on Validations:
|
sort_order
optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
Field name | Type | Possible values |
---|---|---|
addon | string | |
content_view | string | |
content_view_id | integer | |
description | text | |
environment | string | |
name | string | |
organization_id | integer | |
role | string | |
subscription_id | string | |
subscription_name | string | |
usage | string |
POST /katello/api/activation_keys { "organization_id": 114267492, "activation_key": { "name": "limited Key", "unlimited_hosts": false, "max_hosts": 0 } } 422 { "displayMessage": "Validation failed: Max hosts cannot be less than one", "errors": { "max_hosts": [ "cannot be less than one" ] } }
Param name | Description |
---|---|
organization_id
required |
organization identifier Validations:
|
name
required |
name Validations:
|
description
optional |
description Validations:
|
environment
optional |
environment Validations:
|
environment_id
optional |
environment id Validations:
|
content_view_id
optional |
content view id Validations:
|
max_hosts
optional |
maximum number of registered content hosts Validations:
|
unlimited_hosts
optional |
can the activation key have unlimited hosts Validations:
|
release_version
optional |
content release version Validations:
|
service_level
optional |
service level Validations:
|
auto_attach
optional |
auto attach subscriptions upon registration Validations:
|
purpose_usage
optional |
Sets the system purpose usage Validations:
|
purpose_role
optional |
Sets the system purpose usage Validations:
|
purpose_addons
optional |
Sets the system add-ons Validations:
|
PUT /katello/api/activation_keys/568942081 { "organization_id": 114267492, "activation_key": { "name": "New Name", "max_hosts": 2 } } 200 { "service_level": null, "content_overrides": [], "id": 568942081, "name": "Simple Activation Key", "description": "A simple activation key.", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
organization_id
required |
organization identifier Validations:
|
name
optional |
name Validations:
|
description
optional |
description Validations:
|
environment_id
optional |
environment id Validations:
|
content_view_id
optional |
content view id Validations:
|
max_hosts
optional |
maximum number of registered content hosts Validations:
|
unlimited_hosts
optional |
can the activation key have unlimited hosts Validations:
|
release_version
optional |
content release version Validations:
|
service_level
optional |
service level Validations:
|
auto_attach
optional |
auto attach subscriptions upon registration Validations:
|
purpose_usage
optional |
Sets the system purpose usage Validations:
|
purpose_role
optional |
Sets the system purpose usage Validations:
|
purpose_addons
optional |
Sets the system add-ons Validations:
|
DELETE /katello/api/activation_keys/568942081 { "organization_id": 114267492, "activation_key": { "organization_id": 114267492 } } 204
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
GET /katello/api/activation_keys/568942081 204
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
organization_id
optional |
organization identifier Validations:
|
show_hosts
optional |
Show hosts associated to an activation key Validations:
|
POST /katello/api/activation_keys/568942081/copy { "organization_id": 114267492, "new_name": "NewAK", "activation_key": { "organization_id": 114267492 } } 201 { "service_level": null, "content_overrides": [], "id": null, "name": "NewAK", "description": "A simple activation key.", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": 135138680, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": null, "updated_at": null, "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }
Param name | Description |
---|---|
new_name
required |
Name of new activation key Validations:
|
id
required |
ID of the activation key Validations:
|
organization_id
optional |
organization identifier Validations:
|
Param name | Description |
---|---|
search
optional |
Search string Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return Validations:
|
order
optional |
Sort field and order, eg. 'id DESC' Validations:
|
full_result
optional |
Whether or not to show all results Validations:
|
sort_by
optional |
Field to sort the results on Validations:
|
sort_order
optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
name
optional |
host collection name to filter by Validations:
|
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
host_collection_ids
required |
List of host collection IDs to associate with activation key Validations:
|
PUT /katello/api/activation_keys/568942081/host_collections { "organization_id": 114267492, "host_collection_ids": [], "activation_key": { "organization_id": 114267492, "host_collection_ids": [] } } 200 { "service_level": null, "content_overrides": [], "id": 568942081, "name": "Simple Activation Key", "description": "A simple activation key.", "unlimited_hosts": true, "auto_attach": true, "content_view_id": 30237652, "environment_id": 562075838, "usage_count": 0, "user_id": null, "max_hosts": null, "release_version": null, "purpose_usage": null, "purpose_role": null, "organization_id": 114267492, "organization": { "name": "Empty Organization", "label": "Empty_Organization", "id": 114267492 }, "created_at": "2024-02-22 18:22:29 UTC", "updated_at": "2024-02-22 18:22:29 UTC", "content_view": { "id": 30237652, "name": "ACME Default ContentView" }, "environment": { "name": "Library", "id": 562075838 }, "products": [ { "id": 785257261, "name": "Fedora" } ], "host_collections": [], "purpose_addons": [], "permissions": { "view_activation_keys": true, "edit_activation_keys": true, "destroy_activation_keys": true } }
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
host_collection_ids
required |
List of host collection IDs to disassociate from the activation key Validations:
|
POST /katello/api/activation_keys/568942081/add_subscriptions { "organization_id": 114267492, "subscription_id": 123, "activation_key": { "organization_id": 114267492 } } 204
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
subscription_id
optional |
Subscription identifier Validations:
|
quantity
optional |
Quantity of this subscription to add Validations:
|
subscriptions
optional |
Array of subscriptions to add Validations:
|
subscriptions[id]
optional |
Subscription Pool uuid Validations:
|
subscriptions[quantity]
optional |
Quantity of this subscriptions to add Validations:
|
POST /katello/api/activation_keys/568942081/remove_subscriptions { "organization_id": 114267492, "subscription_id": 123, "activation_key": { "organization_id": 114267492 } } 204
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
subscription_id
optional |
Subscription ID Validations:
|
subscriptions
optional |
Array of subscriptions to add Validations:
|
subscriptions[id]
optional |
Subscription Pool uuid Validations:
|
PUT /katello/api/activation_keys/568942081/content_override { "content_overrides": [ { "content_label": "fedora", "name": "enabled", "value": true } ], "activation_key": {} } 204
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
content_overrides
optional |
Array of Content override parameters to be added in bulk Validations:
|
content_overrides[content_label]
required |
Label of the content Validations:
|
content_overrides[value]
optional |
Override value. Provide a boolean value if name is 'enabled' Validations:
|
content_overrides[name]
optional |
Override parameter key or name. Note if name is not provided the default name will be 'enabled' Validations:
|
content_overrides[remove]
optional |
Set true to remove an override and reset it to 'default' Validations:
|
Param name | Description |
---|---|
id
required |
ID of the activation key Validations:
|
content_access_mode_all
optional |
Get all content available, not just that provided by subscriptions Validations:
|
content_access_mode_env
optional |
Limit content to just that available in the activation key's content view version Validations:
|
search
optional |
Search string Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return Validations:
|
order
optional |
Sort field and order, eg. 'id DESC' Validations:
|
full_result
optional |
Whether or not to show all results Validations:
|
sort_by
optional |
Field to sort the results on Validations:
|
sort_order
optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|