Skip to main content
POST
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Body

application/json
task_name
string
required

The task to run, as task_name from GET /upgrade_steps.

Example:

"capture_methods"

arguments
object

Values for the task's declared parameters, keyed by parameter name. A key the task does not declare is rejected.

dry_run
boolean

Report what would change without writing. Ignored by tasks that do not support a dry run, which run for real.

Response

maintenance task started

id
string
required
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
enqueued,
running,
interrupted,
cancelling,
cancelled,
succeeded,
errored
dry_run
boolean
required
initiated_via
string
required
tick_count
number
required
tick_total
number | null
required
error_class
string | null
required
error_message
string | null
required
started_at
string | null
required
ended_at
string | null
required
created_at
string
required
updated_at
string
required
task_name
string
required
duration
number | null
required
tallies
object
required
arguments
object
required
error_backtrace
string | null
required
active
boolean
required
admin_user_id
string | null
required
admin_user
object