> ## Documentation Index > Fetch the complete documentation index at: https://docs.sandywp.com/llms.txt > Use this file to discover all available pages before exploring further. # Snapshot a sandbox into a new template > Snapshots a `ready` sandbox the caller owns into a new Template. **Async** — this call returns immediately with the Template in status `"building"` and enqueues a `template_snapshot` job on the sandbox's worker; poll `GET /api/app/templates/{id}` until `status` becomes `"ready"` (or `"failed"`, see `failureReason`). Free on every plan. ## OpenAPI ````yaml /openapi.yaml post /api/app/templates openapi: 3.1.0 info: title: SandyWP API version: 0.1.0 summary: Complete supported customer API for SandyWP automation. description: > This is the complete supported customer API for automating SandyWP sandboxes, reusable Templates and Blueprints, Imports, Workspaces, account credentials, and OAuth connection setup. It is the stable HTTP contract for developer integrations; browser, provider, and operations routes on the same host are deliberately not part of this document. **Exclusions ledger.** The specification excludes guest/launcher creation (`POST /api/sites`), account profile/avatar/password/support and GitHub UI handlers, billing checkout/portal/sync, public launch routes, plugin/theme search proxies, storage, activity telemetry, newsletter, health, metrics, impersonation, Slack/GitHub callbacks, Git/Polar webhooks, all `/api/admin/**`, and all `/api/internal/**` worker or SSH-control routes. Those endpoints are browser backends, provider callbacks, or operational control-plane interfaces rather than supported developer APIs. ## Conventions - Requests and responses are JSON. Send `Content-Type: application/json` on writes (the file upload and plugin-ZIP-upload endpoints instead use `multipart/form-data`, as noted on those operations). - Sandboxes and Templates are addressed by their opaque `id` in the API (for example `site_abc123`, `tpl_xyz789`). - Errors use a consistent envelope — see the `Error` schema. Some actions require a paid plan and fail with HTTP `402` and a specific error code (for example `template_sharing_requires_paid_plan`); each is called out on the operation that returns it. - **Async by default.** Provisioning and other slow sandbox mutations happen on a worker, not inline in the HTTP request. An endpoint that starts one either returns a `jobId` to poll (see the `Job` / `JobSummary` schemas and each operation's description), returns the resource in a non-terminal state (a site `"creating"`, a Template `"building"`) to re-fetch until it settles, or both. - A personal bearer token can call the authenticated operations below. A scoped OAuth token is accepted only by `GET /api/account/me` and the Imports family; it needs `import:read` or `import:write` for the matching import operation. Other REST operations treat scoped tokens as unauthenticated. contact: name: SandyWP url: https://app.sandywp.com/docs/api servers: - url: https://app.sandywp.com security: - bearerAuth: [] tags: - name: Templates description: >- A Template is a snapshot of a finished sandbox — WordPress/PHP versions, plugins, themes, content, and database — ready to restore in seconds. Templates come from saving a ready sandbox, and can optionally be published as a public "launch this demo" link. - name: Sites description: >- A Site is a disposable WordPress sandbox: its lifecycle (create/restore/reset/delete) and the per-sandbox tools built on top of it (PHP runtime & ini config, WordPress debug settings, database access, outgoing-email capture, plugin deploys, the file manager, Git deployment, and SSH access). - name: Blueprints description: >- Reviewable WordPress build recipes that can be validated, saved, run on a sandbox, or baked into a Template. - name: Imports description: >- Archive-upload workflows for cloning a live WordPress site or pushing a local installation. Scoped OAuth tokens may use only this family, with `import:read` for reads and `import:write` for mutations. - name: Workspaces description: Workspace selection plus member and custom-role administration. - name: Account description: Identity, usage, personal API tokens, and account SSH public keys. - name: OAuth description: >- Public-client registration and PKCE authorization-code token exchange for supported connectors. paths: /api/app/templates: post: tags: - Templates summary: Snapshot a sandbox into a new template description: > Snapshots a `ready` sandbox the caller owns into a new Template. **Async** — this call returns immediately with the Template in status `"building"` and enqueues a `template_snapshot` job on the sandbox's worker; poll `GET /api/app/templates/{id}` until `status` becomes `"ready"` (or `"failed"`, see `failureReason`). Free on every plan. operationId: createTemplate parameters: - $ref: '#/components/parameters/WorkspaceHeaderParam' requestBody: required: true content: application/json: schema: type: object required: - siteId - name properties: siteId: type: string description: The id of the caller's own `ready` sandbox to snapshot. example: site_abc123 name: type: string description: >- 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: type: string description: Optional description. responses: '200': description: >- The new Template, in status `"building"` while the snapshot job runs. content: application/json: schema: type: object required: - template properties: template: $ref: '#/components/schemas/Template' '400': description: >- `invalid_request` — `siteId` or `name` missing/empty. `invalid_name` — the slugified `name` has fewer than 3 alphanumeric characters. content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: >- `site_not_found` — no such sandbox, or it is not visible to the caller. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- `site_not_ready` — the source sandbox is not `ready`. `snapshot_in_progress` — a snapshot of this sandbox is already running. `slug_exists` — a Template with the derived slug already exists. content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: WorkspaceHeaderParam: name: X-SandyWP-Workspace in: header required: false description: >- 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. schema: type: string schemas: Template: type: object description: A reusable snapshot of a finished sandbox. required: - id - userId - orgId - createdByUserId - name - slug - description - sourceSiteId - artifactId - status - failureReason - wordpressVersion - phpVersion - sizeBytes - launchEnabled - launchToken - launchCount - launchQuotaMode - launchEntryMode - launchExpirationMode - launchExpirationMinutes - launchLandingPath - launchBranding - launchProtected - sourceBlueprintId - sourceBlueprintRevision - createdAt - updatedAt properties: id: type: string example: tpl_xyz789 userId: type: string orgId: type: string createdByUserId: type: - string - 'null' name: type: string slug: type: string description: type: - string - 'null' sourceSiteId: type: - string - 'null' description: >- The sandbox this Template was snapshotted from, if any (null for a Blueprint-baked Template). artifactId: type: - string - 'null' description: >- The snapshot artifact backing this Template. Null while `status` is `"building"`. status: $ref: '#/components/schemas/TemplateStatus' failureReason: type: - string - 'null' wordpressVersion: type: string phpVersion: type: string sizeBytes: type: integer launchEnabled: type: boolean launchToken: type: - string - 'null' description: >- Opaque token in the public `/launch/` URL. Set once a link has ever been enabled. launchCount: type: integer description: Number of sandboxes launched from this Template's public link. launchQuotaMode: $ref: '#/components/schemas/LaunchQuotaMode' launchEntryMode: $ref: '#/components/schemas/LaunchEntryMode' launchExpirationMode: $ref: '#/components/schemas/DemoExpirationMode' launchExpirationMinutes: type: - integer - 'null' description: >- Null means the mode default applies: 1440 (24h) for fixed, 60 (1h) for inactivity. launchLandingPath: type: string example: /wp-admin/ launchBranding: oneOf: - $ref: '#/components/schemas/LaunchBranding' - type: 'null' launchProtected: type: boolean description: >- Defaults to true. See `protected` on the launcher-configuration endpoint. sourceBlueprintId: type: - string - 'null' description: >- Set when this Template was baked from a Blueprint (out of this document's scope) rather than snapshotted from a sandbox. sourceBlueprintRevision: type: - integer - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time Error: type: object description: >- The standard error envelope returned by every endpoint on a non-2xx response. required: - error properties: error: type: object required: - code - message properties: code: type: string description: >- A stable, machine-readable error code (e.g. `invalid_request`, `site_not_found`, `plan_limit_reached`). See each operation for the codes it can return. example: invalid_request message: type: string description: A human-readable message. Safe to display to an end user. details: type: object description: >- Optional structured context (e.g. `{"plan": "free", "limit": 2}` for a plan-limit error). Omitted entirely on the generic internal-error fallback; `{}` when an error has no extra context. additionalProperties: true TemplateStatus: type: string enum: - building - ready - failed LaunchQuotaMode: type: string description: Who a launched demo counts against. enum: - visitor - owner LaunchEntryMode: type: string description: >- Whether a launch-link visitor enters anonymously or must give an email first. enum: - anonymous - email DemoExpirationMode: type: string description: >- `fixed` expires a demo/idle-mode sandbox after a fixed lifetime from creation/launch; `inactivity` renews the deadline while it is actively used. enum: - fixed - inactivity LaunchBranding: type: object description: >- Custom copy/colors for a Template's public launch landing page. Every field is optional; unknown or invalid values (bad hex colors, non-http(s) URLs, over-length text) are dropped silently rather than rejected. properties: eyebrow: type: string maxLength: 40 headline: type: string maxLength: 90 subhead: type: string maxLength: 240 buttonLabel: type: string maxLength: 40 logoUrl: type: string format: uri description: Must be an http(s) URL. brandName: type: string maxLength: 40 accentColor: type: string pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ example: '#3366ff' backgroundColor: type: string pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ backgroundImageUrl: type: string format: uri description: Must be an http(s) URL. hidePoweredBy: type: boolean responses: Unauthorized: description: >- No valid bearer token was presented, or a scoped OAuth token was used outside its allowed Imports and account-identity routes. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: auth_required message: A logged-in user is required. details: {} Forbidden: description: >- The caller's current workspace Role does not grant the capability this action requires. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: capability_required message: Your role does not allow this. details: capability: internals securitySchemes: bearerAuth: type: http scheme: bearer description: >- Personal API token, sent as `Authorization: Bearer `. 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. ````