Sign in

Start Sandbox Provisioning Route

Start or attach to sandbox provisioning for an existing request.

Requires service-key authentication, and the authenticated organization must match the request body. Repeated calls return the persisted state or attach to the deterministic workflow instead of creating another sandbox.

post/api/py/sandbox/provisioning/start

Request body

request_idstring uuid required
organization_idstring required
user_idstring required
workflow_idstring required
workflow_namestring required
task_queuestring required

Response

Successful Response

request_idstring uuid required
workflow_idstring required
workflow_run_idstring nullable required
status'requested' | 'starting' | 'running' | 'sandbox_ready' | 'skipped' | 'start_failed' | 'failed' required
sandbox_instance_idstring uuid nullable

Changes