Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductSites and appsSite

Site routes: publish

The Site Verbs publish as api.sb routes, with inputs, result, refusals and an example.

Reference for Site, one group of Site routes.

Site.publish

Publish puts a Site’s current Pages live on its Domains, under its Brand. Verb page.

Text
POST /{namespace}/sites/{site}/publish

Path: site. Emits Site.published.

Inputs

InputTypeRequiredDescription
siteSiterequiredThe Site to publish.

Returns

OutputTypeRequiredDescription
siteSiterequiredThe Site, now live.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab/publish \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/kilnbakery.com",
  "site": {
    "$id": "https://api.sb/kilnbakery.com/sites/site_kqt1HxwFab",
    "$type": "Site",
    "kind": "api"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Site.publish",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}

update, delete

Previous

Brand

Next