Get a site's metadata

GET

/api/sites/{path}

• Your gotifacts apex (canonical base domain), fronted by your reverse proxy. Any configured alias domains serve the same API and sites, but responses (e.g. base_domain) always report the canonical domain.

Returns a single site’s registry metadata. Available to any authenticated user; hidden sites are visible only to admins (they return 404 otherwise).

Authorizations

• forwardAuth

Parameters

Path Parameters

path

required

string

Full site path — group segments (0–2) plus the slug, e.g. claude/app or demo.

Responses

200

The site.

object

id

required

integer format: int64

group

required

Group path (0–2 segments); empty for a flat site.

string

slug

required

string

title

required

string

description

string

date

string

tags

Array<string>

repo

string

preview

Optional preview image URL used by the portal instead of a live iframe.

string

hidden

required

boolean

size

required

Total on-disk size in bytes of the current revision’s files.

integer format: int64

has_favicon

True when the server has a cached favicon for the site, detected from the published index.html at publish time. Fetch the bytes from GET /api/sites/{path}/favicon.

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

deleted_at

Set when the site is soft-deleted; absent for live sites.

string format: date-time

401

Missing or invalid credentials.

object

error

required

string

404

No such site, key, or connection.

object

error

required

string