GET /katello/api/activation_keys
激活码列表

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

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

参数

参数名字 描述
organization_id
必填

机构识别符

Validations:

  • Must be a number.

environment_id
选填

环境识别符

Validations:

  • Must be a number.

content_view_id
选填

内容视图标识符

Validations:

  • Must be a number.

name
选填

根据其进行过滤的激活码密钥名称

Validations:

  • String

search
选填

搜索字符串

Validations:

  • String

page
选填

页号,从 1 开始

Validations:

  • Must be a number.

per_page
选填

每页中显示的返回结果数

Validations:

  • Must be a number.

order
选填

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
选填

无论如何显示所有结果

Validations:

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

sort
选填

'order' 参数的哈希版本

Validations:

  • Hash

sort[by]
选填

结果排序字段

Validations:

  • String

sort[order]
选填

如何对分类结果进行排序(例如:ASC 代表升序)

Validations:

  • String


POST /katello/api/activation_keys
创建激活码

参数

参数名字 描述
organization_id
必填

机构识别符

Validations:

  • Must be a number.

name
必填

名称

Validations:

  • String

description
选填

描述

Validations:

  • String

environment
选填

环境

Validations:

  • Hash

environment_id
选填

环境 id

Validations:

  • Must be a number.

content_view_id
选填

内容视图 id

Validations:

  • Must be a number.

max_hosts
选填

已注册内容主机的最大数

Validations:

  • Must be a number.

unlimited_hosts
选填

can the activation key have unlimited hosts

Validations:

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


PUT /katello/api/activation_keys/:id
更新激活码

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

organization_id
必填

机构识别符

Validations:

  • Must be a number.

name
选填

名称

Validations:

  • String

description
选填

描述

Validations:

  • String

environment_id
选填

环境 id

Validations:

  • Must be a number.

content_view_id
选填

内容视图 id

Validations:

  • Must be a number.

max_hosts
选填

已注册内容主机的最大数

Validations:

  • Must be a number.

unlimited_hosts
选填

can the activation key have unlimited hosts

Validations:

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

release_version
选填

内容发行本版本

Validations:

  • String

service_level
选填

服务等级

Validations:

  • String

auto_attach
选填

注册后自动附加订阅

Validations:

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


DELETE /katello/api/activation_keys/:id
消除激活码

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.


GET /katello/api/activation_keys/:id
显示激活码

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

organization_id
选填

机构识别符

Validations:

  • Must be a number.


POST /katello/api/activation_keys/:id/copy
复制激活码

参数

参数名字 描述
new_name
必填

新激活码名称

Validations:

  • String

id
必填

激活码 ID

Validations:

  • Must be a number.

organization_id
选填

机构识别符

Validations:

  • Must be a number.


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

参数

参数名字 描述
search
选填

搜索字符串

Validations:

  • String

page
选填

页号,从 1 开始

Validations:

  • Must be a number.

per_page
选填

每页中显示的返回结果数

Validations:

  • Must be a number.

order
选填

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
选填

无论如何显示所有结果

Validations:

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

sort
选填

'order' 参数的哈希版本

Validations:

  • Hash

sort[by]
选填

结果排序字段

Validations:

  • String

sort[order]
选填

如何对分类结果进行排序(例如:ASC 代表升序)

Validations:

  • String

name
选填

根据其进行过滤的主机集合名称

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
显示激活码的可用发行版本

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
显示可用于激活码的内容

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • String

content_access_mode_all
选填

Get all content available, not just that provided by subscriptions

Validations:

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

content_access_mode_env
选填

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

Validations:

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


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

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

host_collection_ids
必填

与激活码关联的主机集合 ID 列表

Validations:

  • Must be an array of any type


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

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

host_collection_ids
必填

要与激活码取消全连的主机集合 ID 列表

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
附加订阅

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

subscription_id
选填

订阅识别符

Validations:

  • Must be a number.

quantity
选填

要添加的订阅数量

Validations:

  • Must be a number.

subscriptions
选填

要添加的订阅阵列

Validations:

  • Must be an Array of nested elements

subscriptions[id]
选填

订阅池 uuid

Validations:

  • String

subscriptions[quantity]
选填

要在这个订阅中添加的数量

Validations:

  • Must be a number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
取消附加订阅

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

subscription_id
选填

订阅 ID

Validations:

  • String

subscriptions
选填

要添加的订阅阵列

Validations:

  • Must be an Array of nested elements

subscriptions[id]
选填

订阅池 uuid

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
为 activation_key 覆盖内容

参数

参数名字 描述
id
必填

激活码 ID

Validations:

  • Must be a number.

content_override
选填

内容覆盖参数

Validations:

  • Hash

content_override[content_label]
必填

内容标签

Validations:

  • String

content_override[value]
必填

Override to a boolean value or 'default'

Validations:

  • String

content_overrides
选填

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
必填

内容标签

Validations:

  • String

content_overrides[value]
选填

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

Validations:

  • String

content_overrides[name]
选填

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

Validations:

  • String

content_overrides[remove]
选填

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

Validations:

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