Publish (create or replace) a site

POST

/ingest/sites

• 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.

Requires the publish capability on the target group (admin keys always pass). Idempotent: the same group/slug replaces the existing site.

Authorizations

• bearerAuth

Request Body^required

multipart/form-data with a JSON meta part and either a bundle (a .tar.gz or .zip archive containing an index.html) or an index (a single self-contained HTML document). The archive format is detected from its magic bytes, not the field or file name.

object

meta

required

The meta part of a publish request.

object

group

required

string

slug

required

string

title

string

description

string

date

string

tags

Array<string>

repo

string

preview

string

hidden

boolean

bundle

A .tar.gz or .zip archive containing a top-level index.html. For .zip, if every file lives under one common top-level directory (e.g. a zipped folder site/index.html), that directory is stripped so index.html lands at the site root.

string format: binary

index

A single self-contained HTML document (becomes index.html).

string format: binary

Responses

200

The published site.

object

url

required

string format: uri

group

required

string

slug

required

string

updated_at

required

string format: date-time

400

Invalid request (bad path, malformed body, or missing content).

object

error

required

string

401

Missing or invalid credentials.

object

error

required

string

403

Authenticated, but not permitted for this target/capability.

object

error

required

string