Stop Wrapper

​

POST /resources/wrappers//stop

​

Authentication

​

Path Parameters

​

Response

​

Example Request

curl -X POST https://api.example.com/resources/wrappers/550e8400-e29b-41d4-a716-446655440000/stop \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Example Response (Success)

{
  "wrapper_id": "550e8400-e29b-41d4-a716-446655440000",
  "success": true,
  "message": "Wrapper stopped successfully"
}

​

Example Response (Failure)

{
  "wrapper_id": "550e8400-e29b-41d4-a716-446655440000",
  "success": false,
  "message": "Failed to stop wrapper"
}

​

Error Responses

{
  "detail": "Stop error: Process not found"
}

​

Behavior by Wrapper Type

• Terminates the running process
• Updates wrapper status to stopped
• Preserves checkpoint data (high/low water marks) for resumption

• These typically complete quickly and may not be running when stop is called
• Returns success if wrapper is already completed
• No action needed if wrapper is not actively executing

​

Notes

• The endpoint is idempotent - calling it multiple times has the same effect
• Stopping a wrapper preserves its state and execution history
• Stopped wrappers can be restarted by calling the execute endpoint
• For API wrappers, the wrapper will resume from its last checkpoint when restarted