Skip to content
WP Engine |Headless Platform

List all Headless Platform applications associated with your account

GET
/v1/accounts/{account}/apps

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A successful response.

AppsList

List of Headless Platform applications associated with the account

object
apps
A list of Headless Platform applications
Array<object>
App

App represents a Headless Platform application with source code coming from a specified repository.

object
appId
App ID
string
createTime
Timestamp - app created

Timestamp of when the Headless Platform application was created.

string format: date-time
name
App name

Name of your Headless Platform application. Will be generated if not specified.

string
region
App hosting region

Region where the App is going to be deployed. Format: region/{region} Values: regions/EU-W - Europe West regions/UK - United Kingdom regions/US-C - DisplayName regions/AUS-SE - Australia Southeast

string
repository

Source code repository data.

object
displayName

The display name of the repository in format of {owner}/{repo}.

string
name
required
Name of repository

For zip upload it should be provider/uploadable

string
provider
Git provider

Git repository hosting service used by the application

  • PROVIDER_UNSPECIFIED:
  • GITHUB:
  • GITLAB:
  • BITBUCKET:
  • UPLOADABLE:
string
default: PROVIDER_UNSPECIFIED
Allowed values: PROVIDER_UNSPECIFIED GITHUB GITLAB BITBUCKET UPLOADABLE