Skip to content
WP EngineDocumentation

Revalidate domain.

POST
/v1/accounts/{account}/apps/{app}/environments/{environment}/domainMappings/{domain}:revalidate
curl --request POST \
  --url https://js.wpengineapi.com/v1/accounts/example/apps/example/environments/example/domainMappings/example:revalidate \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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

domain
required
string

Domain name of the domain associated with the environment by this DomainMapping Must be a valid domain name as defined in RFC-1123

Request Body

Section titled “Request Body”
Media typeapplication/json

Request to revalidate domain.

object
Examplegenerated
{}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json

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
Examplegenerated
{
  "done": true,
  "metadata": {
    "@type": "example",
    "build": "example",
    "envID": "example"
  },
  "name": "example"
}