# 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.


GET /katello/api/environments
Umgebungen in Organisation auflisten

GET /katello/api/organizations/:organization_id/environments
Umgebungen in Organisation auflisten

Parameter

Parametername Beschreibung
organization_id
optional

Organisations-ID

Validations:

  • Must be a number.

library
optional

“true” angeben, um nur Library-Umgebungen zu sehen

Validations:

  • Must be one of: true, false.

name
optional

nur Umgebungen mit diesem Namen filtern

Validations:

  • String

search
optional

Suchbegriff

Validations:

  • String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optional

Ob alle Ergebnisse angezeigt werden sollen

Validations:

  • Must be one of: true, false, 1, 0

sort
optional

Hash-Version des “order”-Parameters

Validations:

  • Hash

sort[by]
optional

Ergebnisse nach diesem Feld sortieren

Validations:

  • String

sort[order]
optional

Reihenfolge der sortierten Ergebnisse (z. B. ASC für aufsteigend)

Validations:

  • String


GET /katello/api/environments/:id
Umgebung anzeigen

GET /katello/api/organizations/:organization_id/environments/:environment_id
Umgebung anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

ID der Umgebung

Validations:

  • Must be a number.

organization_id
optional

ID der Organisation

Validations:

  • Must be a number.


POST /katello/api/environments
Umgebung erstellen

POST /katello/api/organizations/:organization_id/environments
Umgebung in einer Organisation erstellen

Parameter

Parametername Beschreibung
organization_id
verpflichtend

Name der Organisation

Validations:

  • Must be a number.

name
verpflichtend

Name der Umgebung

Validations:

  • String

label
optional

Kennung der Umgebung

Validations:

  • String

description
optional

Beschreibung der Umgebung

Validations:

  • String

registry_name_pattern
optional

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
optional

allow unauthenticed pull of container images

Validations:

  • Must be one of: true, false, 1, 0

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:

  • Integer


PUT /katello/api/environments/:id
Umgebung aktualisieren

PUT /katello/api/organizations/:organization_id/environments/:id
Umgebung in einer Organisation aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

ID der Umgebung

Validations:

  • Must be a number.

organization_id
optional

Name der Organisation

Validations:

  • Must be a number.

new_name
optional

Neuer Name für die Umgebung

Validations:

  • String

description
optional

Beschreibung der Umgebung

Validations:

  • String

registry_name_pattern
optional

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
optional

allow unauthenticed pull of container images

Validations:

  • Must be one of: true, false, 1, 0

async
optional

Do not wait for the update action to finish. Default: true

Validations:

  • Must be one of: true, false, 1, 0


DELETE /katello/api/environments/:id
Umgebung löschen

DELETE /katello/api/organizations/:organization_id/environments/:id
Umgebung in einer Organisation löschen

Parameter

Parametername Beschreibung
id
verpflichtend

ID der Umgebung

Validations:

  • Must be a number.

organization_id
optional

Organisations-ID

Validations:

  • Must be a number.


GET /katello/api/organizations/:organization_id/environments/paths
Umgebungspfade auflisten

Parameter

Parametername Beschreibung
organization_id
optional

Organisations-ID

Validations:

  • Must be a number.

permission_type
optional

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

Validations:

  • String