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

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

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

Params

Param Name Description
organization_id
Required

組織 ID

Validations:

  • number.

environment_id
Optional

環境 ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_id
Optional

コンテンツビュー ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

name
Optional

フィルターするアクティベーションキー名

Validations:

  • String

search
Optional

検索文字列

Validations:

  • String

page
Optional

1 から始まるページ番号

Validations:

  • number.

per_page
Optional

戻されるページごとの結果数

Validations:

  • number.

order
Optional

フィールドと順序のソート (例: 'name DESC')

Validations:

  • String

full_results
Optional

すべての結果を表示するかどうか

Validations:

  • boolean

sort
Optional

ハッシュバージョンの 'order' パラメーター

Validations:

  • Hash

sort[by]
Optional

結果をソートするフィールド

Validations:

  • String

sort[order]
Optional

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

Validations:

  • String


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

Params

Param Name Description
organization_id
Required

組織 ID

Validations:

  • number.

name
Required

名前

Validations:

  • String

description
Optional

説明

Validations:

  • String

environment
Optional

環境

Validations:

  • Hash

environment_id
Optional

環境 ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_id
Optional

コンテンツビュー ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

max_hosts
Optional

登録されたコンテンツホストの最大数

Validations:

  • number.

unlimited_hosts
Optional

can the activation key have unlimited hosts

Validations:

  • boolean


PUT /katello/api/activation_keys/:id
アクティベーションキーの更新

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

organization_id
Required

組織 ID

Validations:

  • number.

name
Optional

名前

Validations:

  • String

description
Optional

説明

Validations:

  • String

environment_id
Optional

環境 ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_view_id
Optional

コンテンツビュー ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

max_hosts
Optional

登録されたコンテンツホストの最大数

Validations:

  • number.

unlimited_hosts
Optional

can the activation key have unlimited hosts

Validations:

  • boolean

release_version
Optional

コンテンツリリースバージョン

Validations:

  • String

service_level
Optional

サービスレベル

Validations:

  • String

auto_attach
Optional

登録時のサブスクリプションの自動割り当て

Validations:

  • boolean


DELETE /katello/api/activation_keys/:id
アクティベーションキーの破棄

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


GET /katello/api/activation_keys/:id
アクティベーションキーの表示

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

organization_id
Optional

組織 ID

Validations:

  • number.


POST /katello/api/activation_keys/:id/copy
アクティベーションキーのコピー

Params

Param Name Description
new_name
Required

新規アクティベーションキーの名前

Validations:

  • String

id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

organization_id
Optional

組織 ID

Validations:

  • number.


GET /katello/api/activation_keys/:id/host_collections/available
システムが属さないホストコレクションを一覧表示

Params

Param Name Description
search
Optional

検索文字列

Validations:

  • String

page
Optional

1 から始まるページ番号

Validations:

  • number.

per_page
Optional

戻されるページごとの結果数

Validations:

  • number.

order
Optional

フィールドと順序のソート (例: 'name DESC')

Validations:

  • String

full_results
Optional

すべての結果を表示するかどうか

Validations:

  • boolean

sort
Optional

ハッシュバージョンの 'order' パラメーター

Validations:

  • Hash

sort[by]
Optional

結果をソートするフィールド

Validations:

  • String

sort[order]
Optional

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

Validations:

  • String

name
Optional

フィルターに使用するホストコレクション名

Validations:

  • String


GET /katello/api/activation_keys/:id/releases
アクティベーションキーに利用可能なリリースバージョンを表示

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
アクティベーションキーに利用可能なコンテンツの表示

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • String


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

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_collection_ids
Required

アクティベーションキーに関連付けるホストコレクション ID の一覧

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_collection_ids
Required

アクティベーションキーから関連付けを解除するホストコレクション ID の一覧

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
サブスクリプションを割り当てる

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

subscription_id
Optional

サブスクリプション ID

Validations:

  • number.

quantity
Optional

追加するこのサブスクリプションの数量

Validations:

  • number.

subscriptions
Optional

追加するサブスクリプションの配列

Validations:

  • Must be an Array of nested elements

subscriptions[id]
Optional

サブスクリプションプール UUID

Validations:

  • String

subscriptions[quantity]
Optional

追加するこのサブスクリプションの数量

Validations:

  • number.


PUT /katello/api/activation_keys/:id/remove_subscriptions
サブスクリプションの割り当て解除

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

subscription_id
Optional

サブスクリプション ID

Validations:

  • String

subscriptions
Optional

追加するサブスクリプションの配列

Validations:

  • Must be an Array of nested elements

subscriptions[id]
Optional

サブスクリプションプール UUID

Validations:

  • String


PUT /katello/api/activation_keys/:id/content_override
activation_key のコンテンツを上書き

Params

Param Name Description
id
Required

アクティベーションキーの ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

content_override
Optional

コンテンツ上書きパラメーター

Validations:

  • Hash

content_override[content_label]
Required

コンテンツのラベル

Validations:

  • String

content_override[value]
Required

0/1 に上書きまたは 'default'

Validations:

  • Must be one of: 0, 1, default.