Skip to content

GET /api/v1/instances/{instance_id}

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

Read Instance

Auth: Authorization: Bearer <token> required

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

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

HugoInstanceRead — Successful Response

FieldTypeDescription
attached_scinteger | null (opt.)
backend"gcs" | "local-fs" | "wp" (opt.)
base_urlstring | null (opt.)
captionstring | null (opt.)
createtimestring
gcs_bucketstring | null (opt.)
guidinteger
hostnamestring | null (opt.)
instance_idstring
is_activeboolean (opt.)
last_build_atstring | null
last_publish_atstring | null
ownerinteger | null (opt.)
posts_countinteger
registryobject (opt.)
rsidinteger
template_dirstring | null (opt.)
theme_repostring | null (opt.)
theme_shastring | null (opt.)
tier"prod" | "dev" | "test" | "staging" (opt.)
updatedbyinteger | null (opt.)
updatetimestring
vps_ipstring | null (opt.)
vps_portinteger | null (opt.)
warmup_state"cold" | "warming" | "warm"
ParameterInRequiredTypeDefaultConstraintsDescription
instance_idpathyesstring——
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.