Skip to content

Update site metadata

PATCH
/ingest/sites/{path}

Requires the patch capability on the target group.

path
required
string

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

Metadata-only update. Omit a field to leave it unchanged.

object
title
string
description
string
date
string
tags
Array<string>
repo
string
preview
string
hidden
boolean

The updated 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

Missing or invalid credentials.

object
error
required
string

Authenticated, but not permitted for this target/capability.

object
error
required
string

No such site, key, or connection.

object
error
required
string