Cancelar Execução de Playbook
POST/external/v1/playbook-runs/:id/cancelCancela uma execução em andamento. As etapas ainda não concluídas passam a cancelled e saem das listas de tarefas de todos; as etapas concluídas ficam como estão. Uma execução cancelada não pode ser retomada: inicie o playbook de novo, se precisar.
Autenticação
Requer permissão playbooks:run.
Parâmetros de Caminho
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Identificador da execução (UUID) |
Corpo da Requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
reason | string | Não | Por que a execução foi cancelada (máx. 1000 caracteres) |
Requisição
bash
curl --request POST \
--url "https://app.getraze.com/external/v1/playbook-runs/3ef8c1c3-c081-4187-a6aa-657fbf1a813b/cancel" \
--header "Content-Type: application/json" \
--header "X-API-Key: YOUR_API_KEY" \
--data '{ "reason": "Negócio perdido" }'javascript
const axios = require('axios');
const runId = '3ef8c1c3-c081-4187-a6aa-657fbf1a813b';
const response = await axios.post(
`https://app.getraze.com/external/v1/playbook-runs/${runId}/cancel`,
{ reason: 'Negócio perdido' },
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
console.log(response.data);python
import requests
run_id = '3ef8c1c3-c081-4187-a6aa-657fbf1a813b'
response = requests.post(
f'https://app.getraze.com/external/v1/playbook-runs/{run_id}/cancel',
headers={'X-API-Key': 'YOUR_API_KEY'},
json={'reason': 'Negócio perdido'}
)
print(response.json())Resposta
A execução, no formato de Buscar Execução de Playbook, com status: cancelled, cancelled_at e cancelled_reason.
Erros
| Status | Código | Descrição |
|---|---|---|
| 404 | NOT_FOUND | Execução não encontrada nesta conta |
| 409 | CONFLICT | A execução não está em andamento (já concluída ou cancelada) |