POST /api/v1/instances

Note

Generated from the OpenAPI contract — do not edit by hand. Interactive explorer with full schemas: https://entherium.duckdns.org:8443/reference; frozen spec for this build: openapi.json. Group: instances.

Create Instance

Auth: Authorization: Bearer <token> required

Request

curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/instances" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"attached_sc":"<attached_sc>","backend":"<backend>","base_url":"<base_url>","caption":"<caption>","gcs_bucket":"<gcs_bucket>","hostname":"<hostname>","instance_id":"<instance_id>","is_active":"<is_active>","registry":"<registry>","template_dir":"<template_dir>","theme_repo":"<theme_repo>","theme_sha":"<theme_sha>","tier":"<tier>","vps_ip":"<vps_ip>","vps_port":"<vps_port>"}'

Response 201

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

Returns

HugoInstanceRead — Successful Response

Field	Type	Description
attached_sc	integer | null (opt.)
backend	"gcs" | "local-fs" | "wp" (opt.)
base_url	string | null (opt.)
caption	string | null (opt.)
createtime	string
gcs_bucket	string | null (opt.)
guid	integer
hostname	string | null (opt.)
instance_id	string
is_active	boolean (opt.)
last_build_at	string | null
last_publish_at	string | null
owner	integer | null (opt.)
posts_count	integer
registry	object (opt.)
rsid	integer
template_dir	string | null (opt.)
theme_repo	string | null (opt.)
theme_sha	string | null (opt.)
tier	"prod" | "dev" | "test" | "staging" (opt.)
updatedby	integer | null (opt.)
updatetime	string
vps_ip	string | null (opt.)
vps_port	integer | null (opt.)
warmup_state	"cold" | "warming" | "warm"

Parameters

Parameter	In	Required	Type	Default	Constraints	Description
Idempotency-Key	header	no	string	—	uuid	Optional.

Request body

Field	Type	Required	Description
attached_sc	integer | null	no
backend	"gcs" | "local-fs" | "wp"	no
base_url	string | null	no
caption	string | null	no
gcs_bucket	string | null	no
hostname	string | null	no
instance_id	string	yes
is_active	boolean	no
registry	object	no
template_dir	string | null	no
theme_repo	string | null	no
theme_sha	string | null	no
tier	"prod" | "dev" | "test" | "staging"	no
vps_ip	string | null	no
vps_port	integer | null	no

Errors

Code	Meaning	Body
401	Missing or invalid authentication credentials	ErrorResponse
422	Validation Error	HTTPValidationError

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