Skip to content
POST/api/v1/admin/cleanup

Clean up stale data

Runs data-retention cleanup. Admin-only: requires all of a valid `X-Admin-API-Key`, a session whose email is in `ADMIN_EMAILS` (empty ADMIN_EMAILS = 500 CONFIG_ERROR), and a fresh single-use passkey step-up grant for the `destructive_ops` capability (on by default via DEFAULT_STEP_UP_CAPS; opt out with PLATFORM_STEP_UP_CAPS). Optional body { retention } maps resource → days (int 1-3650); invalid/out-of-range overrides are silently dropped. Rate-limited to 5/min.

Authentication

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

Request body required

Example

{
  "retention": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "retention": {
          "type": "object",
          "additionalProperties": {},
          "description": "Per-resource retention overrides in days; entries outside [1,3650] or non-integer are dropped."
        }
      },
      "additionalProperties": false
    }
  }
}

Response

All status codes

200Cleanup result
400Bad Request.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — FORBIDDEN.
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
500Internal Server Error — CONFIG_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/admin/cleanup \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "retention": {} }'

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/admin/cleanup", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "retention": {}
  }),
});
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']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/admin/cleanup",
    headers=headers,
    json={
    "retention": {}
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"retention":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/admin/cleanup", 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

400401403429500

Other Admin endpoints