Retrieve a tenant
Suggest changes
GET /tenants/{tenantId}
Retrieves a tenant.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fields |
query |
False |
||
tenantId |
string |
path |
True |
Error
Status: Default, Default response| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
True |
|
publicId |
string |
False |
|
workingEnvironmentsInformation |
False |
Example error response
{
"name": "string",
"publicId": "string"
}Definitions
See Definitions
Expand
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
Expands
| Name | Type | Required | Description |
|---|---|---|---|
raw |
string |
True |
|
expands |
array[Expand] |
True |
Capacity
| Name | Type | Required | Description |
|---|---|---|---|
size |
number |
True |
Size |
unit |
string |
True |
Unit |
WorkingEnvironmentsInformation
| Name | Type | Required | Description |
|---|---|---|---|
regionsCount |
integer |
False |
Number of regions for which systems exist over this tenant |
totalReservedSize |
False |
||
workingEnvironmentsCount |
integer |
False |
Number of systems created over this tenant |