GET /katello/api/activation_keys
列出啟動金鑰

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

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

參數

參數名字 描述
organization_id
必填

組織識別子

Validations:

  • number.

environment_id
選填

環境識別子

Validations:

  • number.

content_view_id
選填

內容視域識別子

Validations:

  • number.

name
選填

要篩選的啟動金鑰名稱,透過

Validations:

  • String

search
選填

搜尋字串

Validations:

  • String

page
選填

頁數,從 1 開始

Validations:

  • number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • number.

order
選填

排序欄位與次序,例如「name DESC」

Validations:

  • String

full_result
選填

是否顯示所有結果

Validations:

  • boolean

sort
選填

「order」參數的雜湊版本

Validations:

  • Hash

sort[by]
選填

用來排序結果的欄位

Validations:

  • String

sort[order]
選填

如何排序結果的順序(比方說 ASC 從下到上)

Validations:

  • String


POST /katello/api/activation_keys
建立啟動金鑰

參數

參數名字 描述
organization_id
必填

組織識別子

Validations:

  • number.

name
必填

名稱

Validations:

  • String

description
選填

描述

Validations:

  • String

environment
選填

環境

Validations:

  • Hash

environment_id
選填

環境 ID

Validations:

  • number.

content_view_id
選填

內容視域 ID

Validations:

  • number.

max_hosts
選填

已註冊的內容主機之最大數量

Validations:

  • number.

unlimited_hosts
選填

can the activation key have unlimited hosts

Validations:

  • boolean


PUT /katello/api/activation_keys/:id
更新啟動金鑰

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • number.

organization_id
必填

組織識別子

Validations:

  • number.

name
選填

名稱

Validations:

  • String

description
選填

描述

Validations:

  • String

environment_id
選填

環境 ID

Validations:

  • number.

content_view_id
選填

內容視域 ID

Validations:

  • number.

max_hosts
選填

已註冊的內容主機之最大數量

Validations:

  • number.

unlimited_hosts
選填

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
選填

內容發行版本

Validations:

  • String

service_level
選填

服務等級

Validations:

  • String

auto_attach
選填

註冊後自動連接訂閱

Validations:

  • boolean


DELETE /katello/api/activation_keys/:id
銷毀啟動金鑰

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • number.


GET /katello/api/activation_keys/:id
顯示啟動金鑰

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • number.

organization_id
選填

組織識別子

Validations:

  • number.


POST /katello/api/activation_keys/:id/copy
複製啟動金鑰

參數

參數名字 描述
new_name
必填

新啟動金鑰的名稱

Validations:

  • String

id
必填

啟動金鑰的 ID

Validations:

  • number.

organization_id
選填

組織識別子

Validations:

  • 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:

  • number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • number.

order
選填

排序欄位與次序,例如「name DESC」

Validations:

  • String

full_result
選填

是否顯示所有結果

Validations:

  • boolean

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:

  • boolean

content_access_mode_env
選填

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

Validations:

  • boolean


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

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • number.

host_collection_ids
必填

一列將與啟動金鑰產生相聯性的主機集 ID

Validations:

  • Must be an array of any type


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

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • number.

host_collection_ids
必填

一列將與啟動金鑰解除相聯性的主機集 ID

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
連接一組訂閱服務

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • number.

subscription_id
選填

訂閱識別子

Validations:

  • number.

quantity
選填

要新增此訂閱的數量

Validations:

  • number.

subscriptions
選填

欲新增的訂閱集

Validations:

  • Must be an Array of nested elements

subscriptions[id]
選填

訂閱集區的 UUID

Validations:

  • String

subscriptions[quantity]
選填

要新增此訂閱的數量

Validations:

  • number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
取消訂閱的連結

參數

參數名字 描述
id
必填

啟動金鑰的 ID

Validations:

  • 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:

  • 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:

  • boolean