Sign in
Environments

Update Environment

This endpoint updates an Environment identified by the environmentId parameter.

put/v1/environments/{environmentId}

Path parameters

environmentIdstring uuid required

The identifier of the Environment.

Request body

namestring nullable

The name of the Environment.

colorstring nullable

The color of the Environment. RGB or HTML color codes are allowed.

descriptionstring nullable

The description of the Environment.

orderinteger nullable

The order of the Environment represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

Response

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.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.