Skip to main content

​
Update Site Metadata

Update a site’s metadata without publishing a new version. Use this to change the title, description, add password protection, or set an expiry. 
PATCH /api/v1/publish/:slug/metadata

​
Path Parameters

​
slug
string
required
The site slug (e.g., bright-canvas-a7k2).

​
Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
AuthorizationYesBearer sh_live_...

​
Request Body

All fields are optional. Only include the fields you want to change. Set a field to null to clear it.
​
title
string | null
Page title shown in browser tab and social previews.
​
description
string | null
Meta description for social previews.
​
ogImagePath
string | null
Path to an existing file in the site to use as the Open Graph image.
​
password
string | null
Set a password to protect the site. Set to null to remove protection. Passwords are hashed server-side.
​
ttlSeconds
number | null
Set an expiry in seconds from now. Set to null to make permanent.

​
Example

curl -X PATCH https://simplehost.dev/api/v1/publish/bright-canvas-a7k2/metadata \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sh_live_your_key_here" \
  -d '{
    "title": "My Project",
    "description": "A cool project",
    "password": "secret123"
  }'

​
Response (200)

{
  "slug": "bright-canvas-a7k2",
  "updated": true
}