# 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
任意

組織 ID

Validations:

  • number.

library
任意

ライブラリー環境のみを表示する場合 true に設定

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

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

Validations:

  • String


GET /katello/api/environments/:id
環境の表示

GET /katello/api/organizations/:organization_id/environments/:environment_id
環境の表示

パラメーター

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

環境の ID

Validations:

  • number.

organization_id
任意

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

環境の 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
必須

環境の ID

Validations:

  • number.

organization_id
任意

組織 ID

Validations:

  • number.


GET /katello/api/organizations/:organization_id/environments/paths
環境パスを一覧表示

パラメーター

パラメーター名 記述
organization_id
任意

組織 ID

Validations:

  • number.

permission_type
任意

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

Validations:

  • String