GET /katello/api/activation_keys
アクティベーションキーを一覧表示

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

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

パラメーター

パラメーター名 記述
organization_id
必須

組織 ID

Validations:

  • Must be a number.

environment_id
任意

環境 ID

Validations:

  • Must be a number.

content_view_id
任意

コンテンツビュー 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]
任意

ソートされた結果を順序付ける方法 (例: ascending (昇順) の ASC)

Validations:

  • String


POST /katello/api/activation_keys
アクティベーションキーの作成

パラメーター

パラメーター名 記述
organization_id
必須

組織 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
必須

組織 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
任意

組織 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
任意

組織 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]
任意

ソートされた結果を順序付ける方法 (例: ascending (昇順) の 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
任意

サブスクリプション 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