Skip to navigation
API ReferenceDistributed

Collect cluster telemetry data

Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status

Authentication

api-keystring

Authorization key, either read-write or read-only

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

details_levelintegerOptional
The level of detail to include in the response
timeoutintegerOptional>=1Defaults to 60
Timeout for this request

Response

successful operation
usageobject or anyOptional
timefloatOptional
Time spent to process this request
statusstringOptional
resultobjectOptional

Errors

4XX
Client Request Error