| Required role: | TenantReader |
| GET | /api/tenants/ | Returns a specific tenant | |
|---|---|---|---|
| GET | /tenants/ | Returns a specific tenant |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | header | string | Yes | |
| IncludeReferencedObjects | query | bool? | No | |
| IncludeDeleted | query | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Variables | form | IList<VariableDto> | Yes | Variables defined on tenant level |
| AllowedMailDomains | form | IList<string> | Yes | Allowed email domains used for authentication |
| LicensedModules | form | IList<string> | Yes | List of licensed modules for this tenant |
| DefaultDeploymentLifetimeDays | form | short | No | Amount of days until a Deployment expires |
| MaxDeploymentLifetimeDays | form | short | No | Max amount of days until a Deployment expires |
| SystemUnpatchedWarningDays | form | short | No | Amount of days without patching until a unpatched warning is shown |
| SystemBackupMissingWarningHours | form | short | No | Amount of hours without backup until a backup missing warning is shown |
| StopVulnerableResourceAfterDays | form | short | No | Amount of days until a vulnerable resource is getting stopped |
| DeploymentExpirationWarningDays | form | short | No | Amount of days before deployment expiration, which triggers the expiration warning |
| PatchNotificationDays | form | short | No | Amount of days the patch notification is sent out prior to the patch date |
| UseCustomHostnames | form | bool | No | Use a pool with your own hostnames (true) or let the hostname be auto generated (false) |
| RemoveInactiveVulnerabilitiesAfterDays | form | short | No | After how many days inactive vulnerabilities will be purged from database |
| Links | form | IList<LinkDto> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Description | form | string | No | |
| ObjectType | form | ObjectTypes | No | |
| SelfLink | form | string | Yes | |
| Tags | form | IList<TagDto> | Yes | |
| Path | form | IList<PathItemDto> | Yes | |
| Created | form | DateTime | No | |
| CreateUser | form | string | Yes | |
| CreateUserId | form | string | Yes | |
| Modified | form | DateTime | No | |
| ModifyUser | form | string | Yes | |
| ModifyUserId | form | string | Yes | |
| IsDeleted | form | bool | No | |
| Deleted | form | DateTime? | No | |
| DeleteUser | form | string | No | |
| DeleteUserId | form | string | No | |
| Links | form | IList<LinkDto> | Yes |
| None | |
| ConfigItem | |
| Tenant | |
| Collection | |
| Resource | |
| ComputeNode | |
| VirtualMachine | |
| PhysicalMachine | |
| Disk | |
| Subnet | |
| IPAddress | |
| Job | |
| JobEvent | |
| FreezePeriod | |
| ResourceGroup | |
| Deployment | |
| ResourceGroupTemplate | |
| DeploymentTemplate | |
| ResourceProvider | |
| GenericResource | |
| Role | |
| Permission | |
| User | |
| PatchingWindow | |
| Update | |
| ReportDefinition | |
| TimeSeries | |
| DataPoint | |
| Action | |
| ActionAssignment | |
| UserNote |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | No | |
| IsProtected | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | Yes | |
| Link | form | string | Yes | |
| ObjectType | form | ObjectTypes | No | |
| ObjectId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Caption | form | string | Yes | |
| Rel | form | string | Yes | |
| HRef | form | string | Yes | |
| Method | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes |
| Type | form | ValueDataType | No | The data type of the value property |
| Description | form | string | No | |
| IsInherited | form | bool | No | |
| Environment | form | Environments? | No |
| String | |
| Number | |
| Boolean | |
| List |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/tenants/ HTTP/1.1 Host: core.starburst.svc Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"variables":null,"allowedMailDomains":null,"licensedModules":null,"defaultDeploymentLifetimeDays":0,"maxDeploymentLifetimeDays":0,"systemUnpatchedWarningDays":0,"systemBackupMissingWarningHours":0,"stopVulnerableResourceAfterDays":0,"deploymentExpirationWarningDays":0,"patchNotificationDays":0,"useCustomHostnames":false,"removeInactiveVulnerabilitiesAfterDays":0,"links":[{"caption":"Collections","rel":"down","hRef":"/collections/","method":"GET"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"}