Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443136141.7 KB

Updates an environment.

patch/applications/{ApplicationId}/environments/{EnvironmentId}

Path parameters

ApplicationIdstring required

The application ID.

EnvironmentIdstring required

The environment ID.

Request body

Namestring

The name of the environment.

Descriptionstring

A description of the environment.

Response

Success

ApplicationIdstring

The application ID.

Idstring

The environment ID.

Namestring

The name of the environment.

Descriptionstring

The description of the environment.

State'READY_FOR_DEPLOYMENT' | 'DEPLOYING' | 'ROLLING_BACK' | 'ROLLED_BACK'

The state of the environment. An environment can be in one of the following states: <code>READY_FOR_DEPLOYMENT</code>, <code>DEPLOYING</code>, <code>ROLLING_BACK</code>, or <code>ROLLED_BACK</code>

Example response

{
  "ApplicationId": "339ohji",
  "Description": "An environment for examples.",
  "Id": "54j1r29",
  "Name": "Example-Environment",
  "State": "ROLLED_BACK"
}