Get instance metrics
Returns time-series metrics and current distributions for an instance. Supports incremental fetching via the "since" parameter.
Returns time-series metrics and current distributions for an instance. Supports incremental fetching via the "since" parameter.
Preferred API authentication. Use a JWT with the api audience.
In: header
Path Parameters
The UUID of the SoulFire instance to get metrics for.
uuidQuery Parameters
If set, only return snapshots taken after this timestamp. Used for incremental fetching to reduce payload size.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics"{ "snapshots": [ { "timestamp": "2019-08-24T14:15:22Z", "botsOnline": 0, "botsTotal": 0, "packetsSentTotal": "string", "packetsReceivedTotal": "string", "bytesSentTotal": "string", "bytesReceivedTotal": "string", "packetsSentPerSecond": 0.1, "packetsReceivedPerSecond": 0.1, "bytesSentPerSecond": 0.1, "bytesReceivedPerSecond": 0.1, "avgTickDurationMs": 0.1, "maxTickDurationMs": 0.1, "avgHealth": 0.1, "avgFoodLevel": 0.1, "totalLoadedChunks": 0, "totalTrackedEntities": 0, "connections": 0, "disconnections": 0 } ], "distributions": { "healthHistogram": [ 0 ], "foodHistogram": [ 0 ], "dimensionCounts": { "property1": 0, "property2": 0 }, "gameModeCounts": { "property1": 0, "property2": 0 }, "botPositions": [ { "x": 0.1, "z": 0.1, "dimension": "string" } ] }}How is this page?
Refresh Minecraft account POST
Refreshes the authentication tokens for an existing Minecraft account. Used to renew expired access tokens using stored refresh tokens. For Microsoft accounts, this refreshes the Minecraft token, profile, and player certificates. For offline accounts, returns the account unchanged (offline accounts never expire).
Get server metrics GET
Returns server-level system metrics (CPU, memory, threads, GC, aggregate bots). Supports incremental fetching via the "since" parameter.