Turn SSH on/off, or issue a one-click ephemeral key
One endpoint, two actions selected by action. set-access turns SSH on or off for the sandbox; issue-ephemeral mints a short-lived keypair for a one-click session (SSH must already be enabled). The generated private key is returned once and never stored server-side.
Authorizations
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
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.
Path Parameters
The sandbox id.
Body
Required.
set-access, issue-ephemeral set-access only. Turn SSH on/off. Defaults to true when omitted — only an explicit false disables it.
issue-ephemeral only. Requested private-key lifetime in minutes; clamped server-side to at most 24h and to the sandbox's remaining life. Defaults to the server's configured default when omitted.
Response
Result of the requested action.
- Option 1
- Option 2
What a sandbox's owner needs in order to connect over SSH.

