POST /api/tenants/{id}/backup
Backs up the database for a tenant.
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 backup database for. | Define this parameter in the url. |
options | Tenant backup options. | Define this parameter in the body. |
Example
{ "CallbackUrl": "sample string 1" }
Response
Returns a job with information about the progress of the backup operation. Further calls to the jobs API can be made to get updated information about the status of the operation.
Example
{ "Id": "7b21f93e-16ea-4756-b1c3-dbc860c4e8c2", "Progress": 33, "Name": "Create Site", "Status": "Started", "Log": "Creating site...", "CallbackUrl": "https://mycallbackhandler.com/handle/site", "Jobs": 9, "CompletedJobs": 3, "StartedAt": "2023-06-08T20:04:44.1067876Z", "EndedAt": null, "Duration": "03:07:53.8602196", "Timestamp": "20230608200444106", "Tenant": null, "CreatedBy": { "Id": -2, "Email": "Api" }, "HasEnded": false }