Skip to content
WP Engine |Headless Platform

Update the environment.

PATCH
/v1/accounts/{account}/apps/{app}/environments/{environment}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

Name of your WP Engine Headless Platform account

app
required
string

Name of your Headless Platform application

environment
required
string

ID of your environment

Query Parameters

Section titled “Query Parameters ”
validateOnly
boolean

If set, validate the request (domains only) and preview the review, but do not actually post it.

Request Body

Section titled “Request Body ”

Name of the environment to update.

(— The Environment’s name field is used to identify the Environment to be updated. Format: accounts/{account}/apps/{app}/environments/{environment} —)

Name of the environment to update.

(— The Environment’s name field is used to identify the Environment to be updated. Format: accounts/{account}/apps/{app}/environments/{environment} —)

object
branch
required
Branch name

The branch name from which the Environment is going to be built. In case of using .zip upload, the value should equal to uploadable

string
build
Currently deployed build

A Build describes steps taken to deploy (activate) the Environment. Format is: `accounts/{account}/apps/{app}/builds/{build}

string
createTime
Create time

The timestamp when the environment was created.

string format: date-time
displayName
required
Display name

A name of the Environment used for display purposes

string
domains
Domains list

A list of domains associated with the Environment.

Array<string>
reconciling
Reconciling

An Environment is marked as reconciling if its current state does not match the user’s requested intended state (as seen via GetEnvironmentSpec), and the system is working to reconcile them.

boolean
rootDirectory
Root directory

Root directory in which customer code is located.

string
shellVariables
Shell Variable list

A list of environment variables available in the environment’s container.

Array<object>
ShellVariable

Environment variable represents a value available in the environment’s container under the specific key.

object
key
Environment variable key. Must match regex: `[-._a-zA-Z][-._a-zA-Z0-9]*`. Must not match any of the following case-insensitive globs: WPE_*, ATLAS_METADATA*, HEADLESS_METADATA_*, HOME, PORT, K_*, TMP, TMPDIR, TEMP
string
value

Environment variable value.

string
updateTime
Update time

The timestamp when the environment was most recently updated. This value changes every time when user modifies this resource. It may also change when the service modifies the resource, but this is not currently guaranteed.

string format: date-time
wpEnvironment
required
WordPress environment

Name of the WordPress environment linked with this Environment. The Environment will have the same access visibility as wp_environment.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A successful response.

This resource represents a long-running operation that is the result of a network API call

object
done

Information if the operation is done or still in progress

boolean
metadata

Long running operation metadata

object
@type

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message

string
build

Build name in the format of: accounts/{account}/apps/{app}/environments/{environment}/builds/{build}

string
envID

Environment ID

string
name

Operation name in the format of: accounts/{account}/apps/{app}/environments/{environment}/operations/{operation}

string