Activation keys

>>>

GET /katello/api/activation_keys
List activation keys

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

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

Examples

GET /katello/api/organizations/114267492/activation_keys
204

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • Must be a number.
environment_id
optional

environment identifier

Validations:

  • Must be a number.
content_view_id
optional

content view identifier

Validations:

  • Must be a number.
name
optional

activation key name to filter by

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

Examples

POST /katello/api/activation_keys
{
  "organization_id": 114267492,
  "activation_key": {
    "name": "Unlimited Key",
    "unlimited_hosts": true
  }
}
201
{
  "service_level": null,
  "content_overrides": [],
  "id": null,
  "name": "Unlimited Key",
  "description": null,
  "unlimited_hosts": true,
  "auto_attach": true,
  "content_view_id": null,
  "environment_id": null,
  "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": null,
  "environment": null,
  "products": [
    {
      "id": 785257261,
      "name": "Fedora"
    }
  ],
  "host_collections": [],
  "purpose_addons": [],
  "permissions": {
    "view_activation_keys": true,
    "edit_activation_keys": true,
    "destroy_activation_keys": true
  }
}

Params

Param name Description
organization_id
required

organization identifier

Validations:

  • Must be a number.
name
required

name

Validations:

  • String
description
optional

description

Validations:

  • String
environment
optional

environment

Validations:

  • Hash
environment_id
optional

environment id

Validations:

  • Must be a number.
content_view_id
optional

content view id

Validations:

  • Must be a number.
max_hosts
optional

maximum number of registered content hosts

Validations:

  • Must be a number.
unlimited_hosts
optional

can the activation key have unlimited hosts

Validations:

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

content release version

Validations:

  • String
service_level
optional

service level

Validations:

  • String
auto_attach
optional

auto attach subscriptions upon registration

Validations:

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

Sets the system purpose usage

Validations:

  • String
purpose_role
optional

Sets the system purpose usage

Validations:

  • String
purpose_addons
optional

Sets the system add-ons

Validations:

  • Must be an array of any type
>>>

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

Examples

PUT /katello/api/activation_keys/568942081
{
  "organization_id": 114267492,
  "activation_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"
    ]
  }
}

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
organization_id
required

organization identifier

Validations:

  • Must be a number.
name
optional

name

Validations:

  • String
description
optional

description

Validations:

  • String
environment_id
optional

environment id

Validations:

  • Must be a number.
content_view_id
optional

content view id

Validations:

  • Must be a number.
max_hosts
optional

maximum number of registered content hosts

Validations:

  • Must be a number.
unlimited_hosts
optional

can the activation key have unlimited hosts

Validations:

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

content release version

Validations:

  • String
service_level
optional

service level

Validations:

  • String
auto_attach
optional

auto attach subscriptions upon registration

Validations:

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

Sets the system purpose usage

Validations:

  • String
purpose_role
optional

Sets the system purpose usage

Validations:

  • String
purpose_addons
optional

Sets the system add-ons

Validations:

  • Must be an array of any type
>>>

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

Examples

DELETE /katello/api/activation_keys/568942081
{
  "organization_id": 114267492,
  "activation_key": {
    "organization_id": 114267492
  }
}
204

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
>>>

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

Examples

GET /katello/api/activation_keys/568942081
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": "2022-11-08 19:09:32 UTC",
  "updated_at": "2022-11-08 19:09:32 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
  }
}

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
>>>

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

Examples

POST /katello/api/activation_keys/568942081/copy
{
  "new_name": "new name",
  "activation_key": {}
}
204

Params

Param name Description
new_name
required

Name of new activation key

Validations:

  • String
id
required

ID of the activation key

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
>>>

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

Params

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

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

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
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

Examples

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": "2022-11-08 19:09:32 UTC",
  "updated_at": "2022-11-08 19:09:32 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
  }
}

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
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

Examples

POST /katello/api/activation_keys/568942081/add_subscriptions
{
  "organization_id": 114267492,
  "subscription_id": 123,
  "activation_key": {
    "organization_id": 114267492
  }
}
204

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
subscription_id
optional

Subscription identifier

Validations:

  • Must be a number.
quantity
optional

Quantity of this subscription to add

Validations:

  • Must be a 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:

  • Must be a number.
>>>

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

Examples

POST /katello/api/activation_keys/568942081/remove_subscriptions
{
  "organization_id": 114267492,
  "subscription_id": 123,
  "activation_key": {
    "organization_id": 114267492
  }
}
204

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
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

Examples

PUT /katello/api/activation_keys/568942081/content_override
{
  "content_overrides": [
    {
      "content_label": "fedora",
      "name": "enabled",
      "value": true
    }
  ],
  "activation_key": {}
}
204

Params

Param name Description
id
required

ID of the activation key

Validations:

  • Must be a number.
content_overrides
optional

Array of Content override parameters to be added in bulk

Validations:

  • Must be an Array of nested elements
content_overrides[content_label]
required

Label of the content

Validations:

  • String
content_overrides[value]
optional

Override value. Provide a boolean value if name is 'enabled'

Validations:

  • String
content_overrides[name]
optional

Override parameter key or name. Note if name is not provided the default name will be 'enabled'

Validations:

  • String
content_overrides[remove]
optional

Set true to remove an override and reset it to 'default'

Validations:

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

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

Get all content available, not just that provided by subscriptions

Validations:

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

Limit content to just that available in the activation key's content view version

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