POST /api/tenants
Create a tenant by deploying a build.
Remarks
The method returns HTTP 202 and a reference to the job in the LOCATION header.
Request
Parameter | Description | Additional information |
---|---|---|
options | Tenant create options. | Define this parameter in the body. |
Example
{ "Name": "sample string 1", "Comment": "sample string 2", "BuildName": "sample string 3", "Backup": "sample string 4", "CustomSettings": { "sample string 1": "sample string 2", "sample string 3": "sample string 4", "sample string 5": "sample string 6" }, "ThemeColor": "sample string 5", "ThemeName": "sample string 6", "ThemeLogoUrl": "sample string 7", "CallbackUrl": "sample string 8" }
Response
Returns a job with information about the progress of the create operation. Further calls to the jobs API can be made to get updated information about the status of the operation.
Example
{ "Id": "05c51ed4-c90a-4ed5-97ab-f754d1adc427", "Progress": 33, "Name": "Create Site", "Status": "Started", "Log": "Creating site...", "CallbackUrl": "https://mycallbackhandler.com/handle/site", "Jobs": 9, "CompletedJobs": 3, "StartedAt": "2022-12-21T15:08:26.6579236Z", "EndedAt": null, "Duration": "11:26:00.0512167", "Timestamp": "20221221150826657", "Tenant": null, "CreatedBy": { "Id": -2, "Email": "Api" }, "HasEnded": false }