Search documentation
karat

+

K

User Documentation ↗

Upload Version

POST/api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload
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.

Upload a new 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

version
string

The semantic version of the Website.

preview
boolean
optional

Enables the use of preview functionality.

Request body

body
string

The zip file that contains the contents of your application. For more information, refer to the documentation user documentation.

Response body

Version
object
Hide children

Hide children

version
string

The semantic version of the Website.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/octet-stream" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/versions/upload?version=&preview=true" \ -d '@/path/to/file'

Response

Copied!
1 2 3 { "version": "1.2.0" }