Skip to navigation
REST APIOrganizationsClusters

Get cluster by id.

View as Markdown

Retrieve cluster details by Universally Unique Identifier (UUID).

Authentication

AuthorizationBearer
Bearer authentication

Path parameters

clusterUuidstringRequiredformat: "uuid">=1 character

The Universally Unique Identifier (UUID) of the cluster.

Query parameters

verbosityenumOptionalDefaults to full
response verbosity level.
Allowed values:

Response

Executed successfully.
uuidstringformat: "uuid"
tenantIdinteger
The id of the tenant.
namestring1-253 characters
createdAtdatetime
domainstring or nullOptional1-253 characters
versionstring or nullOptional1-50 characters
statusobjectOptional
The cluster's displayed status.
updatedAtdatetime or nullOptional
deletedAtdatetime or nullOptional
lastLivenessdatetime or nullOptional
deleteRequestedAtdatetime or nullOptional
the timestamp value of when the cluster deletion request was received

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error