Skip to content
PATCH/api/v1/security/campaigns/{id}

Update a red-team campaign

Mass-assignment-safe partial update of a campaign scoped to (id, projectId). projectId is required; at least one updatable field must be supplied.

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

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "targetModel": "string",
  "attackPlugins": [
    "string"
  ],
  "schedule": "string",
  "maxRunsPerDay": 1,
  "enabled": false,
  "tags": [
    "string"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "projectId"
      ],
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string",
          "maxLength": 200
        },
        "description": {
          "type": "string",
          "maxLength": 2000
        },
        "targetModel": {
          "type": "string"
        },
        "attackPlugins": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "type": "string"
          }
        },
        "schedule": {
          "type": "string",
          "maxLength": 100
        },
        "maxRunsPerDay": {
          "type": "integer",
          "minimum": 1
        },
        "enabled": {
          "type": "boolean"
        },
        "tags": {
          "type": "array",
          "maxItems": 20,
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Updated campaign.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
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/security/campaigns/00000000-0000-0000-0000-000000000000 \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "name": "string", "description": "string", "targetModel": "string", "attackPlugins": [ "string" ], "schedule": "string", "maxRunsPerDay": 1, "enabled": false, "tags": [ "string" ] }'

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/security/campaigns/00000000-0000-0000-0000-000000000000", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "targetModel": "string",
    "attackPlugins": [
      "string"
    ],
    "schedule": "string",
    "maxRunsPerDay": 1,
    "enabled": false,
    "tags": [
      "string"
    ]
  }),
});
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/security/campaigns/00000000-0000-0000-0000-000000000000",
    headers=headers,
    json={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "targetModel": "string",
    "attackPlugins": [
        "string"
    ],
    "schedule": "string",
    "maxRunsPerDay": 1,
    "enabled": False,
    "tags": [
        "string"
    ]
},
)
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(`{"projectId":"00000000-0000-0000-0000-000000000000","name":"string","description":"string","targetModel":"string","attackPlugins":["string"],"schedule":"string","maxRunsPerDay":1,"enabled":false,"tags":["string"]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/security/campaigns/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 Security endpoints