API Reference

Undeploy Website

POST/api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Remove the currently deployed version of the Website.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: third-party-application:deploy-application-website.

Path parameters

thirdPartyApplicationRid

string

An RID identifying a third-party application created in Developer Console.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

Website

object

Hide children

deployedVersion

string

optional

The version of the Website that is currently deployed.

subdomains

list<Subdomain>

optional

The subdomains from which the Website is currently served.

Show children

Subdomain

string

A subdomain from which a website is served.

Examples

Request

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/undeploy?preview=true"

Response

Copied!

{
  "deployedVersion": "1.2.0"
}