Create a system environment

View as Markdown
Creates a system environment for the authenticated team.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired1-255 characters
The system environment's name. This value must be unique within the team.
colorstringRequiredformat: "^#[0-9A-Fa-f]{6}$"

A six-digit hex color code.

labelstringOptionalformat: "^[a-z0-9_-]+$"<=50 characters

A lowercase, terminal-friendly identifier for the system environment. Accepts only alphanumeric characters, hyphens, and underscores.

descriptionstringOptional<=500 characters
A description of the system environment. To remove a description, pass this value as an empty string.
isProductionbooleanOptionalDefaults to false
If true, the system environment is a production environment.

Response

Successful Response
dataobject
Information about the system environment.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error