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

Update playbook

Updates playbook steps + metadata.

Authentication

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

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": {}
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Updated.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
404(no description)
429(no description)

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/playbooks/{id} \
  -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

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "PATCH",
  path: "/api/v1/playbooks/{id}",
  body: {
    "name": "string",
    "description": "string",
    "enabled": false,
    "execution_rate_limit_per_min": 0
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="PATCH",
    path="/api/v1/playbooks/{id}",
    body={
    "name": "string",
    "description": "string",
    "enabled": False,
    "execution_rate_limit_per_min": 0
},
)
print(response)

Go

package main

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

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/{id}", 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

400401403404429

Other Compliance endpoints