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
необязательно

код окружения

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
обязательно

Идентификатор ключа активации

Validations:

  • Must be a number.

organization_id
обязательно

идентификатор организации

Validations:

  • Must be a number.

name
необязательно

имя

Validations:

  • String

description
необязательно

описание

Validations:

  • String

environment_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
обязательно

Идентификатор ключа активации

Validations:

  • Must be a number.


GET /katello/api/activation_keys/: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
обязательно

Идентификатор ключа активации

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
обязательно

Идентификатор ключа активации

Validations:

  • String


GET /katello/api/activation_keys/:id/product_content
Показать доступное содержимое для ключа активации

Параметры

Имя параметра Описание
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
обязательно

Идентификатор ключа активации

Validations:

  • Must be a number.

host_collection_ids
обязательно

Список идентификаторов коллекций, которым будет назначен ключ активации

Validations:

  • Must be an array of any type


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

Параметры

Имя параметра Описание
id
обязательно

Идентификатор ключа активации

Validations:

  • Must be a number.

host_collection_ids
обязательно

Список идентификаторов коллекций, из которых ключ активации будет удален

Validations:

  • Must be an array of any type


PUT /katello/api/activation_keys/:id/add_subscriptions
Назначить подписку

Параметры

Имя параметра Описание
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
обязательно

Идентификатор ключа активации

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
обязательно

Идентификатор ключа активации

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