Skip to main content

Create Environment

POST 
/v1/products/:productId/environments

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

Request​

Path Parameters

    productId uuidrequired

    The identifier of the Product.

Body

required

    name stringrequired

    Possible values: non-empty and <= 255 characters

    The name of the Environment.

    color stringnullable

    Possible values: <= 255 characters

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

    description stringnullable

    Possible values: <= 1000 characters

    The description of the Environment.

    order int32nullable

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

Responses​

When the creation was successful.

Schema

    product

    object

    Details of the Product.

    organization

    object

    Details of the Organization.

    organizationId uuid

    Identifier of the Organization.

    name stringnullable

    Name of the Organization.

    productId uuid

    Identifier of the Product.

    name stringnullable

    Name of the Product.

    description stringnullable

    Description of the Product.

    order int32

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

    reasonRequired boolean

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

    environmentId uuid

    Identifier of the Environment.

    name stringnullable

    Name of the Environment.

    color stringnullable

    The configured color of the Environment.

    description stringnullable

    Description of the Environment.

    order int32

    The order of the Environment represented on the ConfigCat Dashboard.

    reasonRequired boolean

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

Loading...