Skip to main content

​
Base URL

https://simplehost.dev
All API endpoints are prefixed with /api/v1/ or /api/auth/.

​
Authentication

Authenticated endpoints require a Bearer token in the Authorization header: 
Authorization: Bearer sh_live_your_api_key_here
API keys have the format sh_live_ followed by 32 hex characters. See Authentication for how to get one. Some endpoints work without authentication (anonymous publishing), but with limitations.

​
Content Type

All request bodies must be JSON: 
Content-Type: application/json

​
Response Format

All responses return JSON. Successful responses include the relevant data. Error responses follow a consistent format: 
{
  "error": "Description of what went wrong",
  "code": "ERROR_CODE",
  "status": 400
}
See Errors for all error codes.

​
Rate Limiting

Every API response includes rate limit headers: 
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1711050000
See Rate Limits for limits per plan.

​
Endpoints

​
Publishing

MethodEndpointDescription
POST/api/v1/publishCreate a new site
PUT/api/v1/_upload/:keyUpload a file
POST/api/v1/publish/:slug/finalizeFinalize and go live
PUT/api/v1/publish/:slugUpdate an existing site

​
Management

MethodEndpointDescription
GET/api/v1/publishesList all sites
GET/api/v1/publish/:slugGet site details
DELETE/api/v1/publish/:slugDelete a site
POST/api/v1/publish/:slug/duplicateDuplicate a site
PATCH/api/v1/publish/:slug/metadataUpdate metadata
GET/api/v1/publish/:slug/variablesList site variables
PUT/api/v1/publish/:slug/variablesStore site variables
DELETE/api/v1/publish/:slug/variables/:nameDelete a site variable
GET/api/v1/publish/:slug/proxy-hostsList approved proxy hosts
PUT/api/v1/publish/:slug/proxy-hostsAdd approved proxy hosts
DELETE/api/v1/publish/:slug/proxy-hosts/:hostnameRemove an approved proxy host
POST/api/v1/publish/:slug/claimClaim anonymous site

​
Secure Browser Requests

MethodEndpointDescription
POST/api/v1/proxy/:slugSend a secure proxied request for a site

​
Account

MethodEndpointDescription
GET/api/v1/accountGet account info and usage

​
Handle

MethodEndpointDescription
GET/api/v1/handleGet current handle
PUT/api/v1/handleClaim or change handle
DELETE/api/v1/handleRelease handle

​
Billing

MethodEndpointDescription
POST/api/billing/checkoutCreate checkout session
POST/api/billing/portalManage subscription

​
Authentication

MethodEndpointDescription
POST/api/auth/agent/request-codeRequest verification code
POST/api/auth/agent/verify-codeVerify code and get API key