Skip to content

GET /api/v1/instances/{instance_id}/summary

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Instance Summary

Public polling endpoint (1.5-3s tick on the webui).

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/instances/<instance_id>/summary" \
-H "Authorization: Bearer <token>"

The contract carries no example for this response; schema: InstanceSummary. Field-level shape: interactive explorer.

InstanceSummary — Successful Response

FieldTypeDescription
active_tasksinteger (opt.)
base_urlstring | null
instance_idstring
is_activeboolean
last_build_atstring | null
last_publish_atstring | null
posts_countinteger
warmup_statestring
ParameterInRequiredTypeDefaultConstraintsDescription
instance_idpathyesstring——
refreshquerynobooleanfalse—
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.