List all environments under your Headless Platform application

GET

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

Authorizations

• basicAuth

Parameters

Path Parameters

account

required

string

Name of your WP Engine Headless Platform account

app

required

string

Name of your Headless Platform application

Query Parameters

filter

string

Preview environments/parent environments filter.

Currently allowed expressions are:

• ‘parentEnvironment=“accounts/{account}/apps/{app}/environments/{environment}”’ - selects only Environments which are children of given Environment
• ‘parentEnvironment=""’ - selects only Environments which are parents of other Environments;
• ” - selects all Environments

Responses

200

A successful response.

EnvironmentList

List of Headless Platform environments associated with a given application

object

environments

A list of Environments.

Array<object>

Environment

Environment represents a Headless Platform environment under a given application

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>

name

Resource name

Environment name in the format of: accounts/{account}/apps/{app}/environments/{environment}

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

nextPageToken

A token which can be sent as page_token to retrieve the next page. Unset if there are no more pages.

string