# 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 (products, 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.
| Param name | Description |
|---|---|
|
organization_id optional |
organization identifier Validations:
|
|
library optional |
set true if you want to see only library environments Validations:
|
|
name optional |
filter only environments containing this name Validations:
|
|
search optional |
Search string Validations:
|
|
page optional |
Page number, starting at 1 Validations:
|
|
per_page optional |
Number of results per page to return Validations:
|
|
order optional |
Sort field and order, eg. 'id DESC' Validations:
|
|
full_result optional |
Whether or not to show all results Validations:
|
|
sort_by optional |
Field to sort the results on Validations:
|
|
sort_order optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
| Field name | Type | Possible values |
|---|---|---|
| id | integer | |
| name | string | |
| organization_id | integer |
| Param name | Description |
|---|---|
|
id required |
ID of the environment Validations:
|
|
organization_id optional |
ID of the organization Validations:
|
| Param name | Description |
|---|---|
|
organization_id required |
name of organization Validations:
|
|
name required |
name of the environment Validations:
|
|
label optional |
label of the environment Validations:
|
|
description optional |
description of the environment Validations:
|
|
registry_name_pattern optional |
pattern for container image names Validations:
|
|
registry_unauthenticated_pull optional |
allow unauthenticed pull of container images Validations:
|
|
prior_id required |
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:
|
| Param name | Description |
|---|---|
|
id required |
ID of the environment Validations:
|
|
organization_id optional |
name of the organization Validations:
|
|
new_name optional |
new name to be given to the environment Validations:
|
|
description optional |
description of the environment Validations:
|
|
registry_name_pattern optional |
pattern for container image names Validations:
|
|
registry_unauthenticated_pull optional |
allow unauthenticed pull of container images Validations:
|
|
async optional |
Do not wait for the update action to finish. Default: true Validations:
|
| Param name | Description |
|---|---|
|
id required |
ID of the environment Validations:
|
|
organization_id optional |
organization identifier Validations:
|
| Param name | Description |
|---|---|
|
organization_id optional |
organization identifier Validations:
|
|
permission_type optional |
The associated permission type. One of (readable | promotable) Default: readable Validations:
|