Skip to main content
POST
Snapshot a sandbox into a new template

Authorizations

Authorization
string
header
required

Personal API token, sent as Authorization: Bearer <SANDYWP_API_KEY>. Obtain one from the dashboard account menu (API keys), sandywp auth login, or POST /api/account/tokens. A missing or invalid token returns 401 auth_required. Scoped OAuth tokens are limited to the Imports family and GET /api/account/me; see the top-level conventions.

Headers

X-SandyWP-Workspace
string

Selects which of the caller's workspaces to act in, for accounts belonging to more than one (legacy alias: X-SandyWP-Organization). Defaults to the caller's own personal workspace when omitted. Every id in this API (sandboxes, Templates, repositories) is scoped to a single workspace, so this header changes which set of resources is visible.

Body

application/json
siteId
string
required

The id of the caller's own ready sandbox to snapshot.

Example:

"site_abc123"

name
string
required

Template display name. Slugified to derive the Template's slug; the slugified form must contain at least 3 alphanumeric characters (400 invalid_name otherwise) and must not collide with an existing Template slug (409 slug_exists).

Example:

"Client starter"

description
string

Optional description.

Response

The new Template, in status "building" while the snapshot job runs.

template
object
required

A reusable snapshot of a finished sandbox.