Create an environment

This operation creates a new environment. Environments are isolated variants of an application or service at a specific stage of its lifecycle, such as development, testing, or production. Each environment maintains independent rule sets and variables. Environments support versioning and promotion, enabling teams to develop, validate, and deploy configuration changes safely and efficiently without affecting other stages.

Path Params
string
required

Name of the workspace that unifies all resources for your application or service. You can rename the workspace with a separate operation after you initially create the resource.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
additionalGroupIds
array of strings
length ≥ 0

Additional groups provide a mechanism for cross-team collaboration. You can create these groups in Identity and Access Management to grant fine-grained, functional access to secondary teams. These teams can then interact with, view, or test specific components, such as individual environments or rule sets, without owning the underlying infrastructure.

additionalGroupIds
string
length ≤ 255

An optional description for the environment version to help you identify its specific purpose.

string
length ≤ 255

Name of the environment visible in the Control Center application. You can change this value without affecting the environmentName.

string
length ≤ 255
^[a-z][a-z0-9._-]+$

Name of the environment that uniquely identifies it within a workspace.

profile
object
required

A profile defines a blueprint for environments, establishing core settings such as persistence, routing, network targets, and history retention. It also allows you to adjust key options, including change management and expiration policies.

tags
array of strings

Keywords that describe resources, making filtering, searching, and discovery more efficient.

tags
Response

Language
URL
LoadingLoading…
Response
Choose an example:
application/json