Getting StartedAPI ReferenceRecipesGitHub
API Reference

Get a list of Tenants.

get
https://cluster.ip.address/v2/tenants

Privileges: ORGANIZATION_VIEW

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of strings or null

List of tenantIds to filter.

ids
statuses
array of strings or null

Filter by current status of tenant. If left blank, only active and inactive tenants are returned.

statuses
livenessModes
array of strings or null

Filter by liveness modes of the tenant. This filter only applies is tenant metadata is added for external vendor such as 'IBM'. In all other cases, the values provided for this filter will be ignored.

livenessModes
ownershipModes
array of strings or null

Filter by ownership modes of the tenant. This filter only applies is tenant metadata is added for external vendor such as 'IBM'. In all other cases, the values provided for this filter will be ignored.

ownershipModes
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago