List Tenants
Operation ID: listTenants
List storage tenants of the platform
Request
URI
GET
https://{api_host}/api/v1/tenants
COPY
Query Parameters
integer
offset
Optional
The start index of storage tenants to return
integer
limit
Optional
Maximum number of storage tenants to return
Responses
200
Tenants of the platform scoped by limit and offset
Returns
PageOfTenants
of type(s)
application/json
{
"items": [
{
"name": "ACME",
"active": true,
"tenant_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"cd_tenant_ids": [
"8daca9a9-5b11-4f63-9c52-953a2ef77739"
]
}
],
"page_info": {
"limit": 0,
"offset": 0,
"total": 0
}
}
array of
object
items
Optional
items
object
page_info
Optional
page_info
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v1/tenants