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

Examples

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

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