Skip to main content
PATCH
Update environment

Path Parameters

applicationShortId
string
required
Pattern: ^app(-.+_.+|_.+)$
environmentShortId
string
required
Pattern: ^env(-.+_.+|_.+)$

Body

application/json

Fields to change on an environment. Omitted fields keep their current value; pass at least one.

name
string

New environment name, unique within the application.

Required string length: 1 - 100
url
string<uri>

New public http(s) start URL. Web and API applications only.

isProduction
boolean

Mark the environment as production. The agent avoids destructive actions on production.

applicationBuildShortId
string

Mobile only. Build to launch by default, from create_application_build or GET /applications/{applicationShortId}/builds. It must belong to the same application and use the environment's platform.

Pattern: ^build(-.+_.+|_.+)$
otherApplicationBuildShortIds
string[]

Mobile only, together with applicationBuildShortId. Companion apps installed next to the primary build, replacing the current list. Omit to keep the current list; pass [] to clear it. Every build must belong to the same application, use the same platform, and have a distinct bundle ID. At most 3.

Pattern: ^build(-.+_.+|_.+)$
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

environment
object
required