Skip to main content
GET
Get import status

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 import id.

Response

The import and current restore state.

import
object
required

An import upload and restore lifecycle record.

site
object | null
required

The linked sandbox, when assigned. It includes the public Site fields needed for polling.

siteUrl
string<uri> | null
required
magicLoginUrl
string<uri> | null
required

Issued for a ready Site when available.

progress
object | null
required