Sign in

v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB
Environments

Get Environment

This endpoint returns the metadata of an Environment identified by the environmentId.

get/v1/environments/{environmentId}

Path parameters

environmentIdstring uuid required

The identifier of the Environment.

Response

When everything is ok, the environment data returned.

environmentIdstring uuid required

Identifier of the Environment.

namestring required

Name of the Environment.

colorstring nullable required

The configured color of the Environment.

descriptionstring nullable required

Description of the Environment.

orderinteger required

The order of the Environment represented on the ConfigCat Dashboard.

reasonRequiredboolean required

Determines whether a mandatory reason must be given every time when the Feature Flags or Settings in the given Environment are saved.

approveRequiredboolean required

Determines whether changes must be approved before they are applied in the given Environment.