Trigger a deployment
Triggers a deployment of the connected repository (async git_deploy job; poll the returned deployment’s status via GET /api/app/sites/{id}/repositories). An optional body deploys a specific ref for this run only, without changing the repository’s configured branch. The sandbox must be ready, and only one deployment may be in flight per repository at a time.
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.
Body
Ref to deploy for this run only (branch or tag name — the same grammar covers both). Falls back to the repository's configured branch when omitted, unless refType is tag (which requires an explicit ref).
^[A-Za-z0-9][A-Za-z0-9._/-]{0,200}$branch (default) or tag — only affects how the run is labeled in deployment history; the clone itself is identical either way.
branch, tag Response
The queued deployment.
One deployment run (a single clone+sync) of a connected repository.

