Get tenant status

Returns the tenant's aggregated health and verification details, computed from every credential and subscription beneath it.
Reads the last stored result without contacting the cloud provider, so it is fast and safe to call repeatedly,
but reflects the previous evaluation rather than this moment; a never-evaluated tenant reports Unknown.
Use this to display known health. To re-test connectivity right now, refresh the status instead.

Use the include parameter to request additional details:

  • subscriptions - Include status for each subscription under the tenant
  • credentials - Include detailed status (health, cooldown, usage metrics) for each credential

Multiple values can be combined with commas: include=subscriptions,credentials

Path Params
uuid
required

The unique tenant identifier.

Query Params
string

Comma-separated list of additional data to include (subscriptions, credentials).

Responses

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