v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB

Environments

Create Environment

This endpoint creates a new Environment in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint.

post/v1/products/{productId}/environments

Path parameters

productIdstring uuid required

The identifier of the Product.

Request body

namestring required

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

When the creation was successful.

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.