Skip to content

by Startups.Studio

Product Sites and apps Site

Site.publish

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

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

Noun: Site
Mode: do
Event: Site.published

You, to your agent

Publish the site “Algebra session”.

curl -X POST https://api.sb/tutorloop.com/sites/site_1/publish \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const site = await $.Site.publish({ site: 'site_1' })

npx startup-builder do Site.publish --json '{"site":"site_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Site.publish({ site: 'site_1' })"
  }
}

Inputs

Input	Type	Required	Description
`site`	Site	required	The Site to publish.

Outputs

Output	Type	Required	Description
`site`	Site	required	The Site, now live.

Effects

Emits Site.published.
Performed by the Designer.
Keeps the previous Pages, so a revert restores them.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Site.publish
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Site.publish

When it waits

Gate	Default
Decision class	Medium: two-way, visible
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Site.list

Previous Page

Site.update

Next Page