POST /api/tenants

Create a tenant by deploying a build.


The method returns HTTP 202 and a reference to the job in the LOCATION header.


Parameter Description Additional information
options Tenant create options. Define this parameter in the body.


  "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"


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.


  "Id": "2b37b24b-a94f-4d06-8b69-16db96441827",
  "Progress": 33,
  "Name": "Create Site",
  "Status": "Started",
  "Log": "Creating site...",
  "CallbackUrl": "",
  "Jobs": 9,
  "CompletedJobs": 3,
  "StartedAt": "2021-09-16T07:32:00.9646561Z",
  "EndedAt": null,
  "Duration": "1.15:59:36.8276907",
  "Timestamp": "20210916073200964",
  "Tenant": null,
  "CreatedBy": {
    "Id": -2,
    "Email": "Api"
  "HasEnded": false