GET /katello/api/host_collections/:id
Показать коллекцию узлов

Параметры

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

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

Validations:

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


GET /katello/api/host_collections
Возвращает коллекции узлов

GET /katello/api/organizations/:organization_id/host_collections
Возвращает коллекции в организации

GET /katello/api/activation_keys/:activation_key_id/host_collections
Возвращает коллекции для заданного ключа активации

Параметры

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

Поиск строки

Validations:

  • String

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

Номер страницы, начиная с 1

Validations:

  • number.

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

Число результатов на странице

Validations:

  • number.

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

Поле и порядок сортировки (например, «name DESC»)

Validations:

  • String

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

Показывать все результаты

Validations:

  • boolean

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

Хэш параметра «order»

Validations:

  • Hash

sort[by]
необязательно

Поле сортировки

Validations:

  • String

sort[order]
необязательно

Порядок сортировки (например, ASC — по возрастанию)

Validations:

  • String

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

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

Validations:

  • number.

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

фильтр по имени коллекции

Validations:

  • String

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

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

Validations:

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

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

Отфильтровать результаты по идентификатору узла

Validations:

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

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

Ограничивает результаты только теми коллекциями, которые доступны для указанного здесь объекта. Поддерживается значение «host».

Validations:

  • String


POST /katello/api/host_collections
Создать коллекцию

POST /katello/api/organizations/:organization_id/host_collections
Создать коллекцию

Параметры

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

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

Validations:

  • number.

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

Имя коллекции

Validations:

  • String

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

Validations:

  • String

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

Список идентификаторов узлов в составе коллекции

Validations:

  • Must be an array of any type

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

Максимальное число узлов в коллекции

Validations:

  • Integer

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

Позволяет снять ограничение на количество узлов в коллекции

Validations:

  • boolean


PUT /katello/api/host_collections/:id
Обновить коллекцию узлов

Параметры

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

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

Validations:

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

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

Имя коллекции

Validations:

  • String

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

Validations:

  • String

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

Список идентификаторов узлов в составе коллекции

Validations:

  • Must be an array of any type

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

Максимальное число узлов в коллекции

Validations:

  • Integer

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

Позволяет снять ограничение на количество узлов в коллекции

Validations:

  • boolean


PUT /katello/api/host_collections/:id/add_hosts
Добавить узел в коллекцию

Параметры

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

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

Validations:

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

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

Список идентификаторов узлов

Validations:

  • Must be an array of any type


PUT /katello/api/host_collections/:id/remove_hosts
Удалить узлы из коллекции

Параметры

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

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

Validations:

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

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

Список идентификаторов узлов

Validations:

  • Must be an array of any type


DELETE /katello/api/host_collections/:id
Удалить коллекцию

Параметры

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

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

Validations:

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


POST /katello/api/host_collections/:id/copy
Создать копию коллекции

Параметры

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

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

Validations:

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

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

Имя новой коллекции

Validations:

  • String