Skip to content
PATCH/api/v1/playbooks/dlq

Retry / archive DLQ entry

Acts on one dead-letter entry, selected by `?id` (400 if missing, 404 if the id matches no row). Admin only (`requiredRole: "admin"` + `incidents:update`) — a rerun performs the real side effect, so it is an operator action, and the org is resolved from the DLQ row itself. Body { action }: "rerun" (the DEFAULT) re-executes the failed playbook action SYNCHRONOUSLY inline and then writes the outcome — `resolved` on success, otherwise `pending_retry` with `attempts` incremented and `next_retry_at` +60s, or `dead_lettered` once `attempts` reaches `max_attempts` (default 8); "dismiss" marks the entry `dismissed` with `resolved_at`/`resolved_by` stamped, permanently suppressing it without deleting the row. Any other value is 400. Returns the updated row, plus `rerun_result` on the rerun path.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Response

200 example

{
  "success": true
}

All status codes

200Updated.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
404(no description)
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/playbooks/dlq \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/playbooks/dlq", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("PATCH", "https://evalguard.ai/api/v1/playbooks/dlq", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/playbooks/dlq", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404409429500

Other Compliance endpoints