Skip to main content
POST
Trigger a deployment

Authorizations

Authorization
string
header
required

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

X-SandyWP-Workspace
string

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

id
string
required

The sandbox id.

repoId
string
required

The connected repository id.

Body

application/json
branch
string

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).

Pattern: ^[A-Za-z0-9][A-Za-z0-9._/-]{0,200}$
refType
enum<string>

branch (default) or tag — only affects how the run is labeled in deployment history; the clone itself is identical either way.

Available options:
branch,
tag

Response

The queued deployment.

deployment
object
required

One deployment run (a single clone+sync) of a connected repository.