# 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.
Parametername | Beschreibung |
---|---|
organization_id optional |
Organisations-ID Validations:
|
library optional |
“true” angeben, um nur Library-Umgebungen zu sehen Validations:
|
name optional |
nur Umgebungen mit diesem Namen filtern Validations:
|
search optional |
Suchbegriff Validations:
|
page optional |
Seitennummer, beginnend bei 1 Validations:
|
per_page optional |
Anzahl der angezeigten Ergebnisse pro Seite Validations:
|
order optional |
Sort field and order, eg. 'id DESC' Validations:
|
full_result optional |
Ob alle Ergebnisse angezeigt werden sollen Validations:
|
sort optional |
Hash-Version des “order”-Parameters Validations:
|
sort[by] optional |
Ergebnisse nach diesem Feld sortieren Validations:
|
sort[order] optional |
Reihenfolge der sortierten Ergebnisse (z. B. ASC für aufsteigend) Validations:
|
Parametername | Beschreibung |
---|---|
id verpflichtend |
ID der Umgebung Validations:
|
organization_id optional |
ID der Organisation Validations:
|
Parametername | Beschreibung |
---|---|
organization_id verpflichtend |
Name der Organisation Validations:
|
name verpflichtend |
Name der Umgebung Validations:
|
label optional |
Kennung der Umgebung Validations:
|
description optional |
Beschreibung der Umgebung Validations:
|
registry_name_pattern optional |
pattern for container image names Validations:
|
registry_unauthenticated_pull optional |
allow unauthenticed pull of container images Validations:
|
prior_id verpflichtend |
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:
|
Parametername | Beschreibung |
---|---|
id verpflichtend |
ID der Umgebung Validations:
|
organization_id optional |
Name der Organisation Validations:
|
new_name optional |
Neuer Name für die Umgebung Validations:
|
description optional |
Beschreibung der Umgebung 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:
|
Parametername | Beschreibung |
---|---|
id verpflichtend |
ID der Umgebung Validations:
|
organization_id optional |
Organisations-ID Validations:
|
Parametername | Beschreibung |
---|---|
organization_id optional |
Organisations-ID Validations:
|
permission_type optional |
The associated permission type. One of (readable | promotable) Default: readable Validations:
|