POST /api/tenants/{id}/upgrade
Ugrade a tenant by deploying a new build to it.
Remarks
The method returns HTTP 202 and a reference to the job in the LOCATION header.
Request
Parameter | Description | Additional information |
---|---|---|
id | The id of the tenant to upgrade. | Define this parameter in the url. |
options | Tenant upgrade options. | Define this parameter in the body. |
Example
{ "BuildName": "sample string 1", "CallbackUrl": "sample string 2" }
Response
Returns a job with information about the progress of the upgrade operation. Further calls to the jobs API can be made to get updated information about the status of the operation.
Example
{ "Id": "2d7eb4b9-9567-40ea-9095-011237c405f3", "Progress": 33, "Name": "Create Site", "Status": "Started", "Log": "Creating site...", "CallbackUrl": "https://mycallbackhandler.com/handle/site", "Jobs": 9, "CompletedJobs": 3, "StartedAt": "2023-03-28T23:47:55.6508261Z", "EndedAt": null, "Duration": "19:51:27.3027301", "Timestamp": "20230328234755650", "Tenant": null, "CreatedBy": { "Id": -2, "Email": "Api" }, "HasEnded": false }