Skip to main content
POST
Start an import upload

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.

Body

application/json
sourceUrl
string<uri>
required

HTTP(S) URL of the source WordPress site for restore search-and-replace.

siteId
string

Existing ready Site to overwrite rather than create a new Site.

declaredSizeBytes
number

Optional best-effort uncompressed-size estimate used for a pre-upload quota check. Only a finite non-negative value is used; other numeric values are ignored for legacy-client compatibility.

Response

The import to upload.

importId
string
required
import
object
required

An import upload and restore lifecycle record.