Skip to main content
POST
/
environments
/
{environmentId}
/
clear
Clear environment
curl --request POST \
  --url https://api.example.com/environments/{environmentId}/clear \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-environment: <x-environment>' \
  --data '
{
  "confirmationCode": "<string>",
  "preserveSettings": true
}
'
{
  "message": "<string>",
  "confirmationCode": "<string>"
}

Headers

x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Path Parameters

environmentId
string<uuid>
required

Id of environment.

Body

application/json

Request.

confirmationCode
string | null
preserveSettings
boolean | null

Response

OK

message
string | null
confirmationCode
string | null