> ## 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. # Create a sandbox from a Blueprint > Creates a sandbox and queues a Blueprint run. Poll the returned run and Site until they reach a terminal state. ## OpenAPI ````yaml /openapi.yaml post /api/app/blueprints/{id}/sites 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/blueprints/{id}/sites: post: tags: - Blueprints summary: Create a sandbox from a Blueprint description: >- Creates a sandbox and queues a Blueprint run. Poll the returned run and Site until they reach a terminal state. operationId: createSiteFromBlueprint parameters: - $ref: '#/components/parameters/BlueprintIdParam' - $ref: '#/components/parameters/WorkspaceHeaderParam' requestBody: content: application/json: schema: type: object properties: siteName: type: string description: Defaults to the Blueprint name. duration: $ref: '#/components/schemas/SiteDurationOption' expirationMode: $ref: '#/components/schemas/DemoExpirationMode' workerCode: type: string description: >- Optional worker selection where the account is permitted to choose one. responses: '200': description: The new Site and its queued Blueprint run. content: application/json: schema: $ref: '#/components/schemas/BlueprintSiteResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/BlueprintNotFound' '409': description: '`blueprint_run_in_progress` — wait for an active run to finish.' content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: BlueprintIdParam: name: id in: path required: true description: The Blueprint id. schema: type: string example: bp_abc123 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: SiteDurationOption: type: string description: >- The sandbox's lifespan, interpreted per `expirationMode`. With `expirationMode: fixed`: `1h`, `1d`, `1w` (default), `2w`, `1m`, or `permanent`. With `expirationMode: inactivity`: `10m`, `30m`, `1h`, or `1d` (there is no inactivity-mode `permanent` — a `400 invalid_expiration` rejects that combination). `2w`, `1m`, and `permanent` additionally require a paid plan (`402 duration_requires_paid_plan` / `402 permanent_requires_paid_plan`). enum: - 10m - 30m - 1h - 1d - 1w - 2w - 1m - permanent 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 BlueprintSiteResponse: type: object required: - site - run properties: site: $ref: '#/components/schemas/Site' run: $ref: '#/components/schemas/BlueprintRun' 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 Site: type: object description: >- The owner-facing view of a sandbox. Strips internal provisioning details (container/DB names, password hash, warm-pool ids, routing) and keeps only what a caller needs to use and log into the sandbox. required: - id - name - slug - status - publicUrl - wordpressVersion - phpVersion - workerCode - adminUsername - adminPassword - magicLoginUrl - permanent - expiresAt - expirationMode - idleTimeoutMinutes - createdAt - readyAt - failureReason properties: id: type: string example: site_abc123 name: type: string example: my-sandbox slug: type: string example: my-sandbox status: $ref: '#/components/schemas/SiteStatus' publicUrl: type: string format: uri example: https://my-sandbox.sandywp.dev wordpressVersion: type: string description: >- The concrete installed version (e.g. `7.0.2`), not the request-time alias (e.g. `latest`). phpVersion: type: string workerCode: type: string example: eu1 adminUsername: type: string example: admin adminPassword: type: - string - 'null' description: >- Plaintext admin password. Present here and on single-sandbox responses; omitted from list responses (see `SiteListItem`) so it never rides along on a bulk poll. magicLoginUrl: type: - string - 'null' format: uri permanent: type: boolean expiresAt: type: - string - 'null' format: date-time expirationMode: $ref: '#/components/schemas/DemoExpirationMode' idleTimeoutMinutes: type: - integer - 'null' createdAt: type: string format: date-time readyAt: type: - string - 'null' format: date-time failureReason: type: - string - 'null' BlueprintRun: type: object description: >- One execution of a Blueprint in create, apply, or bake mode. Poll this resource to follow asynchronous Blueprint work. required: - id - blueprintId - orgId - createdByUserId - blueprintRevision - siteId - jobId - mode - status - steps - log - runnerVersion - failureReason - startedAt - finishedAt - createdAt properties: id: type: string example: bpr_333 blueprintId: type: string orgId: type: string createdByUserId: type: - string - 'null' blueprintRevision: type: integer siteId: type: - string - 'null' jobId: type: - string - 'null' mode: type: string enum: - create - apply - bake status: type: string enum: - pending - running - succeeded - failed steps: type: array items: type: object required: - name - status properties: name: type: string status: type: string enum: - pending - running - succeeded - failed durationMs: type: number caption: type: string log: type: string runnerVersion: type: string failureReason: type: - string - 'null' startedAt: type: - string - 'null' format: date-time finishedAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time SiteStatus: type: string enum: - creating - ready - expired - failed - pending_delete - deleted - cleanup_failed responses: BadRequest: description: >- The request body, parameters, or resource state is invalid for this operation. content: application/json: schema: $ref: '#/components/schemas/Error' 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: {} PaymentRequired: description: The current plan does not permit this action or has reached a quota. content: application/json: schema: $ref: '#/components/schemas/Error' 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 BlueprintNotFound: description: >- No such Blueprint exists in the selected workspace, or it is not visible to the caller. content: application/json: schema: $ref: '#/components/schemas/Error' 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. ````