Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as GET /api/sites/{id}/status, addressed under the /api/app namespace.
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.
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.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SandyWP Documentation","colors":{"primary":"#d99830","light":"#e6b14a","dark":"#653c20"},"logo":{"light":"https://mintcdn.com/sandy-wp/dszzseu6N1-_GB7f/images/brand/sandywp-logo-light.png?fit=max\u0026auto=format\u0026n=dszzseu6N1-_GB7f\u0026q=85\u0026s=8e2affd29d5616eeb8d5bc46d549412a","dark":"https://mintcdn.com/sandy-wp/dszzseu6N1-_GB7f/images/brand/sandywp-logo-dark.png?fit=max\u0026auto=format\u0026n=dszzseu6N1-_GB7f\u0026q=85\u0026s=62edaad9c957123ea26d0c9ca6e77b3c","href":"https://sandywp.com"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sandy-wp","hasAudioNarration":false,"actualSubdomain":"sandy-wp","customDomains":["docs.sandywp.com"],"gitSource":{"type":"github","owner":"rizaardiyanto1412","repo":"sandywp","deployBranch":"main","contentDirectory":"mintlify-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae920e6e83198d0a6c82348","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":103},{"language":"default","tag":"Sites","count":38},{"language":"default","tag":"Tools","count":14},{"language":"default","tag":"Account","count":14},{"language":"default","tag":"Blueprints","count":13},{"language":"default","tag":"Imports","count":11},{"language":"default","tag":"Workspaces","count":9},{"language":"default","tag":"Templates","count":7},{"language":"default","tag":"Library","count":5},{"language":"default","tag":"Using sandboxes","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img.nav-logo{height:2.25rem}"}],"page":{"pagePath":"api-reference/endpoints/sites/get-a-sandbox","slug":"/api-reference/endpoints/sites/get-a-sandbox","pageMetadata":{"title":"Get a sandbox","description":"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as `GET /api/sites/{id}/status`, addressed under the `/api/app` namespace.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}","href":"/api-reference/endpoints/sites/get-a-sandbox","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as \", _jsx(_components.code, {\n children: \"GET /api/sites/{id}/status\"\n }), \", addressed under the \", _jsx(_components.code, {\n children: \"/api/app\"\n }), \" namespace.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a sandbox","description":"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as `GET /api/sites/{id}/status`, addressed under the `/api/app` namespace.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}","href":"/api-reference/endpoints/sites/get-a-sandbox","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getSite","tags":["Sites"],"summary":"Get a sandbox","description":"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as `GET /api/sites/{id}/status`, addressed under the `/api/app` namespace.","parameters":["6d4803ba-2760-4fa8-bc65-b2fbf91e104d","825d4147-dd95-4454-9328-008d3b82f6fa"],"responses":{"200":"cadf6a95-7f62-42c0-a035-9258dbfe8269","401":"89ceeeea-0074-4aa9-8c7c-d98076c62f8b","404":"2c810d6a-7cf3-48bf-956d-280335ade12d"},"method":"get","type":"path","servers":["ee9ccad4-7b5f-44f6-ade4-758bbae361d0"],"security":["e73617b5-e337-4569-b7dd-a513402275e4"],"path":"/api/app/sites/{id}","baseUrlOptions":["https://app.sandywp.com"],"title":"Get a sandbox","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6d4803ba-2760-4fa8-bc65-b2fbf91e104d":{"name":"id","in":"path","required":true,"description":"The sandbox id.","schema":{"type":"string","isRequired":true,"description":"The sandbox id.","uniqueKey":"","typeLabel":"string"},"example":"site_abc123"},"825d4147-dd95-4454-9328-008d3b82f6fa":{"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","isRequired":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.","uniqueKey":"","typeLabel":"string"}}},"responses":{"cadf6a95-7f62-42c0-a035-9258dbfe8269":{"description":"The sandbox, its recent provisioning events, and its recent jobs.","content":{"application/json":{"schema":{"type":"object","required":["site","events","jobs"],"properties":{"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","isRequired":true,"uniqueKey":"site.id","typeLabel":"string"},"name":{"type":"string","example":"my-sandbox","isRequired":true,"uniqueKey":"site.name","typeLabel":"string"},"slug":{"type":"string","example":"my-sandbox","isRequired":true,"uniqueKey":"site.slug","typeLabel":"string"},"status":{"type":"string","enum":["creating","ready","expired","failed","pending_delete","deleted","cleanup_failed"],"isRequired":true,"uniqueKey":"site.status","typeLabel":"enum\u003cstring>"},"publicUrl":{"type":"string","format":"uri","example":"https://my-sandbox.sandywp.dev","isRequired":true,"uniqueKey":"site.publicUrl","typeLabel":"string\u003curi>"},"wordpressVersion":{"type":"string","description":"The concrete installed version (e.g. `7.0.4`), not the request-time alias (e.g. `latest`).","isRequired":true,"uniqueKey":"site.wordpressVersion","typeLabel":"string"},"phpVersion":{"type":"string","isRequired":true,"uniqueKey":"site.phpVersion","typeLabel":"string"},"workerCode":{"type":"string","example":"eu1","isRequired":true,"uniqueKey":"site.workerCode","typeLabel":"string"},"adminUsername":{"type":"string","example":"admin","isRequired":true,"uniqueKey":"site.adminUsername","typeLabel":"string"},"adminPassword":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"site.adminPassword.oneOf.0","typeLabel":"string"},{"type":"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.","isRequired":true,"uniqueKey":"site.adminPassword.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site.adminPassword","typeLabel":"string | null"},"magicLoginUrl":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"site.magicLoginUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","isRequired":true,"uniqueKey":"site.magicLoginUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site.magicLoginUrl","typeLabel":"string\u003curi> | null"},"permanent":{"type":"boolean","isRequired":true,"uniqueKey":"site.permanent","typeLabel":"boolean"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"site.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"site.expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site.expiresAt","typeLabel":"string\u003cdate-time> | null"},"expirationMode":{"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"],"isRequired":true,"uniqueKey":"site.expirationMode","typeLabel":"enum\u003cstring>"},"idleTimeoutMinutes":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"site.idleTimeoutMinutes.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"site.idleTimeoutMinutes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site.idleTimeoutMinutes","typeLabel":"integer | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"site.createdAt","typeLabel":"string\u003cdate-time>"},"readyAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"site.readyAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"site.readyAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site.readyAt","typeLabel":"string\u003cdate-time> | null"},"failureReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"site.failureReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"site.failureReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site.failureReason","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"site","typeLabel":"object"},"events":{"type":"array","description":"Most recent events first, capped at 30.","items":{"type":"object","description":"One entry in a sandbox's human-readable provisioning/activity timeline.","required":["id","siteId","jobId","workerCode","kind","message","metadata","createdAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].id","typeLabel":"string"},"siteId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].siteId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].siteId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].siteId","typeLabel":"string | null"},"jobId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].jobId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].jobId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].jobId","typeLabel":"string | null"},"workerCode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].workerCode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].workerCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].workerCode","typeLabel":"string | null"},"kind":{"type":"string","description":"The kind of a site-timeline event. New kinds may be added over time.","enum":["site.created","site.ready","site.failed","site.expired","site.restore_requested","site.restored","site.reset_requested","site.reset","site.cleanup_requested","site.cleaned","site.cleanup_failed","site.provisioning","site.permanence_changed","site.php_config_updated","site.php_version_changed","site.debug_options_updated","worker.heartbeat","worker.claimed_job","worker.job_event","worker.job_result","guest.rejected","admin.action","magic_login.issued","magic_login.used","health.check","warm_pool.building","warm_pool.ready","warm_pool.claim_started","warm_pool.claimed","warm_pool.failed","warm_pool.destroyed","warm_pool.refill","warm_pool.recovered","template.snapshot_requested","template.ready","template.failed","template.deleted","template.launched","import.requested","import.uploaded","import.restoring","import.ready","import.failed","git.repo_connected","git.repo_removed","git.deploy_started","git.deploy_succeeded","git.deploy_failed","github.command_received","github.command_ignored","github.preview_requested","github.preview_deploy_started","github.preview_ready","github.preview_failed","github.preview_delete_requested","slack.command_received","slack.command_completed","slack.command_failed","ssh.key_added","ssh.key_revoked","ssh.access_changed","ssh.session_opened","ssh.session_closed","ssh.session_rejected","blueprint.run_started","blueprint.run_progress","blueprint.run_succeeded","blueprint.run_failed"],"isRequired":true,"uniqueKey":"events.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].message","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"events.items.[INDEX].metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"events.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events","typeLabel":"object[]"},"jobs":{"type":"array","description":"Most recent jobs first, capped at 10.","items":{"type":"object","description":"A background job record, as returned in a sandbox's job history.","required":["id","type","status","siteId","workerCode","payload","attempts","maxAttempts","runAfter","lockedAt","lastError","createdAt","updatedAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"jobs.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["provision_site","cold_provision_site","import_provision_site","expire_site","restore_site","reset_site","health_check","cleanup_site","warm_pool_build","warm_pool_activate_route","warm_pool_destroy","template_snapshot","git_deploy","preview_git_deploy","deploy_plugin","apply_php_config","apply_debug_options","apply_custom_domain","apply_sandbox_resources","switch_php_version","import_sync_site","delete_artifact","reap_orphans","blueprint_apply"],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","claimed","running","succeeded","failed","retryable"],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"siteId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"jobs.items.[INDEX].siteId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].siteId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].siteId","typeLabel":"string | null"},"workerCode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"jobs.items.[INDEX].workerCode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].workerCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].workerCode","typeLabel":"string | null"},"payload":{"type":"object","description":"Worker-internal job payload; shape varies by job type.","additionalProperties":true,"isRequired":true,"uniqueKey":"jobs.items.[INDEX].payload","typeLabel":"object"},"attempts":{"type":"integer","isRequired":true,"uniqueKey":"jobs.items.[INDEX].attempts","typeLabel":"integer"},"maxAttempts":{"type":"integer","isRequired":true,"uniqueKey":"jobs.items.[INDEX].maxAttempts","typeLabel":"integer"},"runAfter":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].runAfter","typeLabel":"string\u003cdate-time>"},"lockedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].lockedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].lockedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].lockedAt","typeLabel":"string\u003cdate-time> | null"},"lastError":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"jobs.items.[INDEX].lastError.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].lastError.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].lastError","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"jobs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"jobs","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"site":{"id":"site_abc123","name":"my-sandbox","slug":"my-sandbox","status":"creating","publicUrl":"https://my-sandbox.sandywp.dev","wordpressVersion":"\u003cstring>","phpVersion":"\u003cstring>","workerCode":"eu1","adminUsername":"admin","adminPassword":"\u003cstring>","magicLoginUrl":"\u003cstring>","permanent":true,"expiresAt":"2023-11-07T05:31:56Z","expirationMode":"fixed","idleTimeoutMinutes":123,"createdAt":"2023-11-07T05:31:56Z","readyAt":"2023-11-07T05:31:56Z","failureReason":"\u003cstring>"},"events":[{"id":"\u003cstring>","siteId":"\u003cstring>","jobId":"\u003cstring>","workerCode":"\u003cstring>","kind":"site.created","message":"\u003cstring>","metadata":{},"createdAt":"2023-11-07T05:31:56Z"}],"jobs":[{"id":"\u003cstring>","type":"provision_site","status":"pending","siteId":"\u003cstring>","workerCode":"\u003cstring>","payload":{},"attempts":123,"maxAttempts":123,"runAfter":"2023-11-07T05:31:56Z","lockedAt":"2023-11-07T05:31:56Z","lastError":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"89ceeeea-0074-4aa9-8c7c-d98076c62f8b":{"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":{"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","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable message. Safe to display to an end user.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"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,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"auth_required","message":"A logged-in user is required.","details":{}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"auth_required","message":"A logged-in user is required.","details":{}}}}},"exampleType":"examples"}},"exampleType":"examples"},"2c810d6a-7cf3-48bf-956d-280335ade12d":{"description":"No such sandbox, or it is not visible to the caller. Ownership failures are intentionally indistinguishable from a missing sandbox.","content":{"application/json":{"schema":{"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","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable message. Safe to display to an end user.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"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,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"site_not_found","message":"Site not found.","details":{}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"site_not_found","message":"Site not found.","details":{}}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e73617b5-e337-4569-b7dd-a513402275e4":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Personal API token, sent as `Authorization: Bearer \u003cSANDYWP_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.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ee9ccad4-7b5f-44f6-ade4-758bbae361d0":{"url":"https://app.sandywp.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Personal API token, sent as `Authorization: Bearer \u003cSANDYWP_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.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal API token, sent as `Authorization: Bearer \u003cSANDYWP_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.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"sandy-wp","siteName":"SandyWP Documentation","title":"Get a sandbox - SandyWP Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T11:39:42.274Z","originalFileLocation":"api-reference/endpoints/sites/get-a-sandbox.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as GET /api/sites/{id}/status, addressed under the /api/app namespace.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SandyWP Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/sandy-wp/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/sandy-wp/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/sandy-wp/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/sandy-wp/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a sandbox - SandyWP Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as GET /api/sites/{id}/status, addressed under the /api/app namespace.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SandyWP Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sandy-wp.mintlify.site/_mintlify/api/og/v2?division=Sites\u0026amp;title=Get+a+sandbox\u0026amp;description=Returns+one+sandbox+with+its+recent+provisioning+events+and+jobs+%E2%80%94+useful+for+showing+live+progress.+Same+response+shape+as+%60GET+%2Fapi%2Fsites%2F%7Bid%7D%2Fstatus%60%2C+addres\u0026amp;theme=7adb8c57347f76c2bf2e915e\u0026amp;signature=c646059634ecf9023a7e5860b75aae5d7d97e683ab791acf6dbdcf00a6446b87\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a sandbox - SandyWP Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as GET /api/sites/{id}/status, addressed under the /api/app namespace.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sandy-wp.mintlify.site/_mintlify/api/og/v2?division=Sites\u0026amp;title=Get+a+sandbox\u0026amp;description=Returns+one+sandbox+with+its+recent+provisioning+events+and+jobs+%E2%80%94+useful+for+showing+live+progress.+Same+response+shape+as+%60GET+%2Fapi%2Fsites%2F%7Bid%7D%2Fstatus%60%2C+addres\u0026amp;theme=7adb8c57347f76c2bf2e915e\u0026amp;signature=c646059634ecf9023a7e5860b75aae5d7d97e683ab791acf6dbdcf00a6446b87\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/sandy-wp/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SandyWP Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#d99830\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/sites/get-a-sandbox.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sandywp.com/#organization\",\"name\":\"SandyWP Documentation\",\"url\":\"https://docs.sandywp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sandy-wp/dszzseu6N1-_GB7f/images/brand/sandywp-logo-light.png?fit=max\u0026auto=format\u0026n=dszzseu6N1-_GB7f\u0026q=85\u0026s=8e2affd29d5616eeb8d5bc46d549412a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sandywp.com#website\",\"name\":\"SandyWP Documentation\",\"url\":\"https://docs.sandywp.com\",\"publisher\":{\"@id\":\"https://docs.sandywp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox#webpage\",\"url\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox\",\"name\":\"Get a sandbox\",\"description\":\"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as GET /api/sites/{id}/status, addressed under the /api/app namespace.\",\"dateModified\":\"2026-10-28T11:39:42.274Z\",\"isPartOf\":{\"@id\":\"https://docs.sandywp.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.sandywp.com/api-reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sites\",\"item\":\"https://docs.sandywp.com/api-reference/endpoints/sites/list-sandboxes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a sandbox\",\"item\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox#apireference\",\"headline\":\"Get a sandbox\",\"name\":\"Get a sandbox\",\"description\":\"Returns one sandbox with its recent provisioning events and jobs — useful for showing live progress. Same response shape as GET /api/sites/{id}/status, addressed under the /api/app namespace.\",\"url\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sandywp.com/api-reference/endpoints/sites/get-a-sandbox#webpage\"},\"dateModified\":\"2026-10-28T11:39:42.274Z\",\"publisher\":{\"@id\":\"https://docs.sandywp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sandywp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SandyWP Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SandyWP Documentation","nav":{"global":null,"groups":[{"group":"Getting started","pages":[{"title":"Welcome to SandyWP","href":"/index"},{"title":"Core concepts","href":"/concepts"}]},{"group":"Using sandboxes","pages":[{"title":"Create a sandbox","href":"/guides/create-a-sandbox"},{"title":"Open wp-admin","href":"/guides/open-wp-admin"},{"title":"Lifespan and permanence","href":"/guides/site-lifespan"},{"title":"Plans and limits","href":"/guides/plans"}]},{"group":"Tools","pages":[{"title":"File Manager","href":"/guides/file-manager"},{"title":"Database","href":"/guides/database"},{"title":"PHP settings","href":"/guides/php"},{"title":"Custom domains","href":"/guides/custom-domains"},{"title":"Email delivery","href":"/guides/email-delivery"},{"title":"Git deployment","href":"/guides/git-deployment"},{"title":"SSH access","href":"/guides/ssh-access"},{"title":"Mount a sandbox","href":"/guides/mount-a-sandbox"},{"title":"Library","href":"/guides/plugin-library"},{"title":"Templates","href":"/guides/templates"},{"title":"Webhooks","href":"/guides/webhooks"},{"title":"Blueprints","href":"/guides/blueprints"},{"title":"Clone a site","href":"/guides/clone-a-site"},{"title":"Push a local site","href":"/guides/push-local-site"}]},{"group":"Integrations","pages":[{"title":"Slack app","href":"/guides/slack"},{"title":"GitHub pull request previews","href":"/guides/github"}]},{"group":"Connectors","pages":[{"title":"Muse connector brief","href":"/connectors/muse"}]},{"group":"Account","pages":[{"title":"Two-factor authentication","href":"/guides/two-factor-authentication"}]},{"group":"Automation guides","pages":[{"title":"API keys","href":"/guides/api-keys"},{"title":"CLI","href":"/cli"}]},{"group":"API Reference","pages":[{"title":"API Reference overview","href":"/api-reference"},{"title":"Blueprint API guidance","href":"/api-reference/blueprints"},{"title":"Imports API guidance","href":"/api-reference/imports"},{"title":"Workspace API guidance","href":"/api-reference/workspaces"},{"title":"OAuth connector flow","href":"/api-reference/oauth"},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/templates","href":"/api-reference/endpoints/templates/list-templates"},{"title":"Snapshot a sandbox into a new template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/templates","href":"/api-reference/endpoints/templates/snapshot-a-sandbox-into-a-new-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/templates/{id}","href":"/api-reference/endpoints/templates/get-a-template"},{"title":"Rename a template","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/app/templates/{id}","href":"/api-reference/endpoints/templates/rename-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/templates/{id}","href":"/api-reference/endpoints/templates/delete-a-template"},{"title":"Configure the template's public launch link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/templates/{id}/launch","href":"/api-reference/endpoints/templates/configure-the-templates-public-launch-link"},{"title":"List a template's captured launch leads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/templates/{id}/leads","href":"/api-reference/endpoints/templates/list-a-templates-captured-launch-leads"}]},{"group":"Sites","pages":[{"title":"List sandboxes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites","href":"/api-reference/endpoints/sites/list-sandboxes"},{"title":"Create a sandbox (or restore one from a template)","description":"Creates a sandbox. All fields are optional; sensible defaults are used (latest WordPress,\nPHP 8.3, standard preset, auto-selected worker).\n\nBy default creation is **synchronous**: the request waits (up to ~60s) until the sandbox\nis ready and returns `status: \"ready\"` with the admin credentials and login URL. If\nprovisioning takes longer, the response comes back with `status: \"creating\"` and HTTP\n`202` — poll `GET /api/app/sites/{id}` until it becomes `\"ready\"`. Pass `background: true`\nto skip the wait and return immediately (also `202` while still `\"creating\"`).\n\nPassing `templateId` restores a saved Template instead of provisioning a blank sandbox\n(fast snapshot restore, no reinstall) — free on every plan, subject to the normal\nsandbox-count and storage limits. In that mode, only `siteName`, `duration`,\n`expirationMode`, and `background` apply; every other field below is silently ignored\n(the sandbox inherits the Template's WordPress/PHP stack).\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites","href":"/api-reference/endpoints/sites/create-a-sandbox-or-restore-one-from-a-template"},{"title":"Get a sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}","href":"/api-reference/endpoints/sites/get-a-sandbox"},{"title":"Rename a sandbox, or set whether it is permanent","description":"Send `name` to rename the sandbox (2-80 characters). The rename changes the display name only: the slug, sandbox URL, and admin login are unchanged. A body containing `name` is treated as a rename and `permanent` is ignored.\n\nSend `permanent` to set whether a sandbox is permanent (never expires). Setting `true` requires a paid plan. Setting `false` on a currently-permanent sandbox reverts it to the default temporary lifespan starting now. A no-op call (value already matches) succeeds without changing `expiresAt`.","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/app/sites/{id}","href":"/api-reference/endpoints/sites/rename-a-sandbox-or-set-whether-it-is-permanent"},{"title":"Restore an expired sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}","href":"/api-reference/endpoints/sites/restore-an-expired-sandbox"},{"title":"Delete a sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/sites/{id}","href":"/api-reference/endpoints/sites/delete-a-sandbox"},{"title":"Apply a blueprint to an existing sandbox","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/blueprint","href":"/api-reference/endpoints/sites/apply-a-blueprint-to-an-existing-sandbox"},{"title":"Issue a database (Adminer) access URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/database","href":"/api-reference/endpoints/sites/issue-a-database-adminer-access-url"},{"title":"Get the sandbox's custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/domain","href":"/api-reference/endpoints/sites/get-the-sandboxs-custom-domain"},{"title":"Connect a custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/sites/{id}/domain","href":"/api-reference/endpoints/sites/connect-a-custom-domain"},{"title":"Disconnect the custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/sites/{id}/domain","href":"/api-reference/endpoints/sites/disconnect-the-custom-domain"},{"title":"Check DNS for the custom domain","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/domain/verify","href":"/api-reference/endpoints/sites/check-dns-for-the-custom-domain"},{"title":"Get WordPress debug settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/debug","href":"/api-reference/endpoints/sites/get-wordpress-debug-settings"},{"title":"Replace WordPress debug settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/sites/{id}/debug","href":"/api-reference/endpoints/sites/replace-wordpress-debug-settings"},{"title":"Explain the debug log with AI","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/debug/explain","href":"/api-reference/endpoints/sites/explain-the-debug-log-with-ai"},{"title":"Tail the debug log","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/debug/log","href":"/api-reference/endpoints/sites/tail-the-debug-log"},{"title":"Clear the debug log","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/sites/{id}/debug/log","href":"/api-reference/endpoints/sites/clear-the-debug-log"},{"title":"Install or deploy a plugin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/deploy-plugin","href":"/api-reference/endpoints/sites/install-or-deploy-a-plugin"},{"title":"Poll a plugin deploy job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/deploy-plugin","href":"/api-reference/endpoints/sites/poll-a-plugin-deploy-job"},{"title":"Get captured outgoing email","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/email","href":"/api-reference/endpoints/sites/get-captured-outgoing-email"},{"title":"Turn email capture on or off","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/sites/{id}/email","href":"/api-reference/endpoints/sites/turn-email-capture-on-or-off"},{"title":"Clear the captured email log","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/sites/{id}/email","href":"/api-reference/endpoints/sites/clear-the-captured-email-log"},{"title":"File manager — read operations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/fs/{op}","href":"/api-reference/endpoints/sites/file-manager-—-read-operations"},{"title":"File manager — write operations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/fs/{op}","href":"/api-reference/endpoints/sites/file-manager-—-write-operations"},{"title":"Get PHP ini configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/php-config","href":"/api-reference/endpoints/sites/get-php-ini-configuration"},{"title":"Replace PHP ini configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/sites/{id}/php-config","href":"/api-reference/endpoints/sites/replace-php-ini-configuration"},{"title":"Switch the PHP runtime version","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/sites/{id}/php-version","href":"/api-reference/endpoints/sites/switch-the-php-runtime-version"},{"title":"List a sandbox's connected Git repositories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/repositories","href":"/api-reference/endpoints/sites/list-a-sandboxs-connected-git-repositories"},{"title":"Connect a Git repository for deploys","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/repositories","href":"/api-reference/endpoints/sites/connect-a-git-repository-for-deploys"},{"title":"Update a connected repository","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/app/sites/{id}/repositories/{repoId}","href":"/api-reference/endpoints/sites/update-a-connected-repository"},{"title":"Disconnect a repository","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/sites/{id}/repositories/{repoId}","href":"/api-reference/endpoints/sites/disconnect-a-repository"},{"title":"List a repository's remote branches and tags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/repositories/{repoId}/branches","href":"/api-reference/endpoints/sites/list-a-repositorys-remote-branches-and-tags"},{"title":"Trigger a deployment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/repositories/{repoId}/deploy","href":"/api-reference/endpoints/sites/trigger-a-deployment"},{"title":"Reset a sandbox to a clean install","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/reset","href":"/api-reference/endpoints/sites/reset-a-sandbox-to-a-clean-install"},{"title":"Get SSH connection details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/sites/{id}/ssh","href":"/api-reference/endpoints/sites/get-ssh-connection-details"},{"title":"Turn SSH on/off, or issue a one-click ephemeral key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/sites/{id}/ssh","href":"/api-reference/endpoints/sites/turn-ssh-onoff-or-issue-a-one-click-ephemeral-key"},{"title":"Issue a one-time login link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/sites/{id}/magic-login","href":"/api-reference/endpoints/sites/issue-a-one-time-login-link"},{"title":"Get sandbox status, events, and jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/sites/{id}/status","href":"/api-reference/endpoints/sites/get-sandbox-status-events-and-jobs"}]},{"group":"Library","pages":[{"title":"List the Library","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/plugin-library","href":"/api-reference/endpoints/library/list-the-library"},{"title":"Add a plugin to the library","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/plugin-library","href":"/api-reference/endpoints/library/add-a-plugin-to-the-library"},{"title":"Remove a plugin from the library","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/plugin-library/{id}","href":"/api-reference/endpoints/library/remove-a-plugin-from-the-library"},{"title":"Store a license key for a library plugin","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/plugin-library/{id}/license-key","href":"/api-reference/endpoints/library/store-a-license-key-for-a-library-plugin"},{"title":"Remove a library plugin's license key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/plugin-library/{id}/license-key","href":"/api-reference/endpoints/library/remove-a-library-plugins-license-key"}]},{"group":"Blueprints","pages":[{"title":"List saved Blueprints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/blueprints","href":"/api-reference/endpoints/blueprints/list-saved-blueprints"},{"title":"Save a Blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints","href":"/api-reference/endpoints/blueprints/save-a-blueprint"},{"title":"Fetch a Blueprint from a URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints/import","href":"/api-reference/endpoints/blueprints/fetch-a-blueprint-from-a-url"},{"title":"Upload a Blueprint ZIP bundle","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints/upload","href":"/api-reference/endpoints/blueprints/upload-a-blueprint-zip-bundle"},{"title":"Generate a Blueprint from a description","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints/generate","href":"/api-reference/endpoints/blueprints/generate-a-blueprint-from-a-description"},{"title":"Validate or adapt a Blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints/validate","href":"/api-reference/endpoints/blueprints/validate-or-adapt-a-blueprint"},{"title":"Get a Blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/blueprints/{id}","href":"/api-reference/endpoints/blueprints/get-a-blueprint"},{"title":"Update a Blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/app/blueprints/{id}","href":"/api-reference/endpoints/blueprints/update-a-blueprint"},{"title":"Delete a Blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/blueprints/{id}","href":"/api-reference/endpoints/blueprints/delete-a-blueprint"},{"title":"List Blueprint runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/blueprints/{id}/runs","href":"/api-reference/endpoints/blueprints/list-blueprint-runs"},{"title":"Get a Blueprint run","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/blueprints/{id}/runs/{runId}","href":"/api-reference/endpoints/blueprints/get-a-blueprint-run"},{"title":"Bake a Blueprint into a Template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints/{id}/bake","href":"/api-reference/endpoints/blueprints/bake-a-blueprint-into-a-template"},{"title":"Create a sandbox from a Blueprint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/blueprints/{id}/sites","href":"/api-reference/endpoints/blueprints/create-a-sandbox-from-a-blueprint"}]},{"group":"Imports","pages":[{"title":"List imports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/imports","href":"/api-reference/endpoints/imports/list-imports"},{"title":"Start an import upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports","href":"/api-reference/endpoints/imports/start-an-import-upload"},{"title":"Get import status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/imports/{id}","href":"/api-reference/endpoints/imports/get-import-status"},{"title":"Cancel or remove an import","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/imports/{id}","href":"/api-reference/endpoints/imports/cancel-or-remove-an-import"},{"title":"Append an import archive chunk","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/app/imports/{id}/upload","href":"/api-reference/endpoints/imports/append-an-import-archive-chunk"},{"title":"Seal a chunked import upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports/{id}/complete","href":"/api-reference/endpoints/imports/seal-a-chunked-import-upload"},{"title":"Initialize direct multipart upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports/{id}/multipart/init","href":"/api-reference/endpoints/imports/initialize-direct-multipart-upload"},{"title":"Get a multipart part upload URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports/{id}/multipart/part","href":"/api-reference/endpoints/imports/get-a-multipart-part-upload-url"},{"title":"Complete a multipart upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports/{id}/multipart/complete","href":"/api-reference/endpoints/imports/complete-a-multipart-upload"},{"title":"Abort multipart upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports/{id}/multipart/abort","href":"/api-reference/endpoints/imports/abort-multipart-upload"},{"title":"Finalize a streamed import","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/imports/{id}/multipart/finalize","href":"/api-reference/endpoints/imports/finalize-a-streamed-import"}]},{"group":"Workspaces","pages":[{"title":"List available workspaces","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/workspaces","href":"/api-reference/endpoints/workspaces/list-available-workspaces"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/workspaces/{id}/members","href":"/api-reference/endpoints/workspaces/list-workspace-members"},{"title":"Invite a workspace member","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/workspaces/{id}/members","href":"/api-reference/endpoints/workspaces/invite-a-workspace-member"},{"title":"Assign a member role","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/app/workspaces/{id}/members/{userId}","href":"/api-reference/endpoints/workspaces/assign-a-member-role"},{"title":"Remove a workspace member","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/workspaces/{id}/members/{userId}","href":"/api-reference/endpoints/workspaces/remove-a-workspace-member"},{"title":"List workspace roles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/workspaces/{id}/roles","href":"/api-reference/endpoints/workspaces/list-workspace-roles"},{"title":"Create a workspace role","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/workspaces/{id}/roles","href":"/api-reference/endpoints/workspaces/create-a-workspace-role"},{"title":"Update a workspace role","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/app/workspaces/{id}/roles/{roleId}","href":"/api-reference/endpoints/workspaces/update-a-workspace-role"},{"title":"Delete a workspace role","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/app/workspaces/{id}/roles/{roleId}","href":"/api-reference/endpoints/workspaces/delete-a-workspace-role"}]},{"group":"Account","pages":[{"title":"Get the current account identity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/account/me","href":"/api-reference/endpoints/account/get-the-current-account-identity"},{"title":"Get plan usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/account/usage","href":"/api-reference/endpoints/account/get-plan-usage"},{"title":"List personal API tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/account/tokens","href":"/api-reference/endpoints/account/list-personal-api-tokens"},{"title":"Create a personal API token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/account/tokens","href":"/api-reference/endpoints/account/create-a-personal-api-token"},{"title":"Revoke a personal API token","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/account/tokens/{id}","href":"/api-reference/endpoints/account/revoke-a-personal-api-token"},{"title":"Get the Demo Launches webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/account/webhooks/demo-launches","href":"/api-reference/endpoints/account/get-the-demo-launches-webhook"},{"title":"Create or update the Demo Launches webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/account/webhooks/demo-launches","href":"/api-reference/endpoints/account/create-or-update-the-demo-launches-webhook"},{"title":"Remove the Demo Launches webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/account/webhooks/demo-launches","href":"/api-reference/endpoints/account/remove-the-demo-launches-webhook"},{"title":"Send a Demo Launches webhook test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/account/webhooks/demo-launches/test","href":"/api-reference/endpoints/account/send-a-demo-launches-webhook-test"},{"title":"Rotate the Demo Launches webhook secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/account/webhooks/demo-launches/rotate","href":"/api-reference/endpoints/account/rotate-the-demo-launches-webhook-secret"},{"title":"List account SSH public keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/account/ssh-keys","href":"/api-reference/endpoints/account/list-account-ssh-public-keys"},{"title":"Add an account SSH public key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/account/ssh-keys","href":"/api-reference/endpoints/account/add-an-account-ssh-public-key"},{"title":"Revoke an account SSH key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/account/ssh-keys/{id}","href":"/api-reference/endpoints/account/revoke-an-account-ssh-key"}]},{"group":"OAuth","pages":[{"title":"Dynamically register a public OAuth client","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/connect/register","href":"/api-reference/endpoints/oauth/dynamically-register-a-public-oauth-client"},{"title":"Exchange an authorization code for an access token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/connect/token","href":"/api-reference/endpoints/oauth/exchange-an-authorization-code-for-an-access-token"}]}]}]},"basePath":"","title":"Get a sandbox - SandyWP Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}