Skip to main content
POST
/
api
/
v2
/
public
/
execution
/
:instanceId
/
stop
curl -X POST "https://app.refold.ai/api/v2/public/execution/{instanceId}/stop" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"

{
  "message": "Stopping instance"
}
Request that a running execution be stopped. The stop is enqueued and acknowledged synchronously.

​
Authentication

This endpoint is scoped to a linked account, so it accepts either authentication method. Option 1 — API key
​
x-api-key
string
Your Refold API key.
​
linked_account_id
string
The linked account.
Option 2 — Session token
​
Authorization
string
Session token. Format: Bearer YOUR_SESSION_TOKEN

​
Path Parameters

​
instanceId
string
required
The execution (instance) ID to stop.

​
Response

​
message
string
Acknowledgement that the stop was requested.
{
  "message": "Stopping instance"
}

curl -X POST "https://app.refold.ai/api/v2/public/execution/{instanceId}/stop" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"