Skip to content
PUT/api/v1/admin/settings

Update admin settings

Updates system settings. Requires admin role. Mass-assignment-safe (ADR-0017): only the 3 known fields accepted; unknown keys rejected.

Authentication

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

Request body required

Example

{
  "maintenanceMode": false,
  "flags": {},
  "adminEmails": [
    "user@example.com"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "maintenanceMode": {
          "type": "boolean"
        },
        "flags": {
          "type": "object",
          "additionalProperties": {
            "type": "boolean"
          }
        },
        "adminEmails": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 254,
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          }
        }
      },
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

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

Code samples

cURL

curl -X PUT \
  https://evalguard.ai/api/v1/admin/settings \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "maintenanceMode": false, "flags": {}, "adminEmails": [ "user@example.com" ] }'

TypeScript

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

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

const response = await client.request({
  method: "PUT",
  path: "/api/v1/admin/settings",
  body: {
    "maintenanceMode": false,
    "flags": {},
    "adminEmails": [
      "user@example.com"
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

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

response = client.request(
    method="PUT",
    path="/api/v1/admin/settings",
    body={
    "maintenanceMode": False,
    "flags": {},
    "adminEmails": [
        "user@example.com"
    ]
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"maintenanceMode":false,"flags":{},"adminEmails":["user@example.com"]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PUT", "https://evalguard.ai/api/v1/admin/settings", 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

400401403429

Other Admin endpoints