# Description

An environment is a basic organization structure that groups hosts, products, repositories, etc. Every host belongs to one environment and it's isolated inside so that it can see only content that is in its environment.

## Chains

Environments are ordered into chains and their content (propducts, repositories, tempaltes, packages) can be moved to an environment only from its prior environment. You can have for example chain like:

Library -> Development -> Testing -> Production

Each change in an environment is done through a changeset in an action called promotion.

## Library

Library is a special environment that has no ascendant: All the content starts in this environment. More chains can start from the library environment but no further branching of a chain is enabled.


GET /katello/api/environments
Показать окружения в организации

GET /katello/api/organizations/:organization_id/environments
Показать окружения в организации

Параметры

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

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

Validations:

  • number.

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

присвойте «True», чтобы показать только окружения Library

Validations:

  • Must be one of: true, false.

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


GET /katello/api/environments/:id
Показать окружение

GET /katello/api/organizations/:organization_id/environments/:environment_id
Показать окружение

Параметры

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

Идентификатор окружения

Validations:

  • number.

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

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

Validations:

  • number.


POST /katello/api/environments
Создать окружение

POST /katello/api/organizations/:organization_id/environments
Создать окружение в организации

Параметры

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

имя организации

Validations:

  • number.

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

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

Validations:

  • String

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

метка окружения

Validations:

  • String

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

описание окружения

Validations:

  • String

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

ID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain.

Validations:

  • Integer


PUT /katello/api/environments/:id
Изменить окружение

PUT /katello/api/organizations/:organization_id/environments/:id
Обновить окружение в организации

Параметры

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

Идентификатор окружения

Validations:

  • number.

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

имя организации

Validations:

  • number.

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

новое имя окружения

Validations:

  • String

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

описание окружения

Validations:

  • String


DELETE /katello/api/environments/:id
Удалить окружение

DELETE /katello/api/organizations/:organization_id/environments/:id
Удалить окружение из организации

Параметры

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

Идентификатор окружения

Validations:

  • number.

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

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

Validations:

  • number.


GET /katello/api/organizations/:organization_id/environments/paths
Показать диаграммы окружений

Параметры

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

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

Validations:

  • number.

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

The associated permission type. One of (readable | promotable) Default: readable

Validations:

  • String