GET /api/tenants/{name}/get

Gets the tenant with the specified name.

Request

Parameter Description Additional information
name The name fo the tenant to get. Define this parameter in the url.

Response

Returns the tenant or HTTP 404 if the tenant was not found.

Example

{
  "Id": 23,
  "Name": "prefix-tenantname",
  "DeploymentStatus": null,
  "Status": "Running",
  "ResourceGroup": "prefix-grp-eastus-180912",
  "HostName": "instancename.domain.com",
  "Cname": "instancename.domain.com",
  "DatabaseServer": "prefix-sql-eastus-180919",
  "DatabaseName": "prefix-instancename",
  "CreatedAt": "2023-06-04T20:05:44.1067876Z",
  "CreatedBy": null,
  "TrashedAt": null,
  "TrashedBy": null,
  "Configuration": "{\"ThemeColor\":\"#ff00ff\",\"ThemeName\":\"Social HQ\"}",
  "Version": "4.3.2",
  "LicenseKey": null,
  "License": {
    "Key": "8CZB5-UTM8U-3GG5U-G1AAP",
    "IssuedTo": "company",
    "MaintenanceExpiresAt": null,
    "TrialExpiresAt": null,
    "GraceDays": 10
  },
  "Comment": "A comment",
  "Title": "instancename",
  "Url": "https://instancename.domain.com",
  "IsTrashed": false
}