InstanceService · InstanceService_GetInstanceStats
Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.
Access
Requires an instance administrator. A normal authenticated account cannot perform this operation.
Request
GetInstanceStats returns resource usage statistics for the instance. Admin only.
GET
/api/v1/instance/statsParameters
No path or query parameters are declared.
Request body
No request body is declared.
Responses
200 · OK
application/json · InstanceStats
default · Default error response
application/json · Status
Complete operation definition
All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.
Open JSON definition
{
"tags": [
"InstanceService"
],
"description": "GetInstanceStats returns resource usage statistics for the instance. Admin only.",
"operationId": "InstanceService_GetInstanceStats",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstanceStats"
}
}
}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}