Skip to main content
PUT
Update an environment

Authorizations

Authorization
string
header
required

Bearer token in the Authorization header (e.g. JWT / Cognito access token).

Headers

Tenant-Id
string
required

ID of the tenant (current tenant context).

Path Parameters

environmentId
string
required

Environment identifier.

Body

application/json
id
string
required
sk
string
required
name
string
required
description
string
status
enum<string>
Available options:
CLONED,
DEFINED,
DEPLOY_IN_PROGRESS,
DEPLOYED,
FAILED,
ROLLBACK,
REQUIRES_MANUAL_DELETION

Response

OK

id
string
sk
string
type
string
created_at
string<date-time>
updated_at
string<date-time>
name
string
description
string
aws_region
enum<string>

AWS region identifier. Matches models.AwsRegion JSON values in paas-lib.

Available options:
us-east-1,
us-east-2,
us-west-1,
us-west-2,
us-gov-east-1,
us-gov-west-1,
ca-central-1,
ca-west-1,
eu-central-1,
eu-central-2,
eu-north-1,
eu-west-1,
eu-west-2,
eu-west-3,
eu-south-1,
eu-south-2,
me-south-1,
me-central-1,
mx-central-1,
cn-north-1,
cn-northwest-1,
ap-east-1,
ap-south-1,
ap-south-2,
ap-northeast-1,
ap-northeast-2,
ap-northeast-3,
ap-southeast-1,
ap-southeast-2,
ap-southeast-3,
ap-southeast-4,
ap-southeast-5,
ap-east-2,
ap-southeast-7,
ap-southeast-6,
af-south-1,
sa-east-1
Example:

"us-east-1"

aws_account_id
string
status
enum<string>
Available options:
CLONED,
DEFINED,
DEPLOY_IN_PROGRESS,
DEPLOYED,
FAILED,
ROLLBACK,
REQUIRES_MANUAL_DELETION
total_resources
integer
env_variables
object[]
webhooks
object[]
last_workflow_id
string
stack_info
string
bootstraped_info
object
month_cost
object | null

Aggregated cost summary for a billing period.