Skip to content
PATCH/api/v1/playbooks/{id}

Update playbook

Partially updates a playbook. Writable fields: `name`, `description`, `enabled`, `trigger`, `actions`, `execution_rate_limit_per_min` (0..10000). Unknown keys are stripped rather than written, and a body with none of the above returns 400 'No fields to update'; `id`, `org_id`, `created_at` and `created_by` are never writable. Editor role — editing re-points the playbook's actions (webhook URLs, revoke_api_key, enabled flag), so it carries the same gate as create. 403 NOT_ORG_MEMBER when the playbook belongs to another org; 404 NOT_FOUND only when the id does not exist. Audit-logged.

Authentication

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

Parameters

id in pathrequired
string

Request body required

Example

{
  "name": "string",
  "description": "string",
  "enabled": false,
  "execution_rate_limit_per_min": 0
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "nullable": true,
          "type": "string",
          "maxLength": 1000
        },
        "enabled": {
          "type": "boolean"
        },
        "trigger": {},
        "actions": {},
        "execution_rate_limit_per_min": {
          "nullable": true,
          "type": "integer",
          "minimum": 0,
          "maximum": 10000
        }
      },
      "additionalProperties": false
    }
  }
}

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

# {id} is shown with an EXAMPLE value — replace it with real values.
curl -X PATCH \
  https://evalguard.ai/api/v1/playbooks/00000000-0000-0000-0000-000000000000 \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "string", "description": "string", "enabled": false, "execution_rate_limit_per_min": 0 }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:
// {id} is shown with an EXAMPLE value — replace it with real values.

const res = await fetch("https://evalguard.ai/api/v1/playbooks/00000000-0000-0000-0000-000000000000", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "enabled": false,
    "execution_rate_limit_per_min": 0
  }),
});
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:
# {id} is shown with an EXAMPLE value — replace it with real values.

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "PATCH",
    "https://evalguard.ai/api/v1/playbooks/00000000-0000-0000-0000-000000000000",
    headers=headers,
    json={
    "name": "string",
    "description": "string",
    "enabled": False,
    "execution_rate_limit_per_min": 0
},
)
print(response.status_code, response.json())

Go

package main

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

// {id} is shown with an EXAMPLE value — replace it with real values.
func main() {
	body := strings.NewReader(`{"name":"string","description":"string","enabled":false,"execution_rate_limit_per_min":0}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/playbooks/00000000-0000-0000-0000-000000000000", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404409429500

Other Compliance endpoints