Builder

Start a new site from one of your team's templates

post/builder/org-templates/{templateId}/sessions

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/builder/org-templates/{templateId}/sessions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

templateIdstring uuid required

Query parameters

orgIdstring

Request body

namestring

Response

The new site

idstring uuid required
organizationIdstring uuid required
projectIdstring uuid required
titlestring required
status'active' | 'archived' required
templatestring required
modelstring required
escalationModelstring nullable required
turnCountinteger required
lastCommitShastring nullable required
editVersioninteger

Live editing: the files' version for preview editors (+1 per edit batch)

pendingEditsinteger

Live editing: preview edits not yet saved as a version (saved within 20 seconds)

firstDraftReadyboolean

Builder v2: a turn has finished successfully, so the site has a first draft (the dashboard shows the live preview only from then on)

publishedUrlstring nullable

Builder v2: the live address after the last successful publish

createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.