Search documentation
karat

+

K

User Documentation ↗

Deploy Website

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

Deploy a 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.

Request body

DeployWebsiteRequest
object
Hide child attributes

Hide child attributes

version
string

The semantic version of the Website.

Response body

Website
object
Hide child attributes

Hide child attributes

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 child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/deploy" \ -d '{"version":"1.2.0"}'

Response

Copied!
1 2 3 4 5 6 { "subdomains": [ "myapp.example.com" ], "deployedVersion": "1.2.0" }