Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Environment

Update an environment

Update the details of a single existing environment.

patch/projects/{projectId}/environments/{environmentId}

Path parameters

projectIdstring required
environmentIdstring required

Request body

namestring

The name of the environment

titlestring

The title of the environment

attributesobject

Arbitrary attributes attached to this resource

type'development' | 'production' | 'staging'

The type of environment (production, staging or development), if not provided, a default will be calculated

parentstring nullable

The name of the parent environment

clone_parent_on_createboolean

Clone data when creating that environment

enable_smtpboolean

Whether to configure SMTP for this environment

restrict_robotsboolean

Whether to restrict robots for this environment

Response

statusstring required

The status text of the response

codeinteger required

The status code of the response