Skip to content
POST/api/v1/api-keys/{keyId}/rotate

Rotate an API key (new key issued; old expires after grace window)

Mints a replacement key with identical scopes/binding and schedules the original to expire after grace_period_hours (default 24). The replacement rawKey is returned ONLY once. Admin role required.

Authentication

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

Parameters

keyId in pathrequired
string

Request body

Example

{
  "grace_period_hours": 24
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "grace_period_hours": {
          "type": "integer",
          "minimum": 1,
          "maximum": 168,
          "default": 24,
          "description": "Hours the original key remains valid after rotation."
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Rotation succeeded — body has replacement.rawKey + original expiry.
400(no description)
401(no description)
403Forbidden — admin role required.
404API key not found.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

# {keyId} is shown with an EXAMPLE value — replace it with real values.
curl -X POST \
  https://evalguard.ai/api/v1/api-keys/00000000-0000-0000-0000-000000000000/rotate \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "grace_period_hours": 24 }'

TypeScript

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

const res = await fetch("https://evalguard.ai/api/v1/api-keys/00000000-0000-0000-0000-000000000000/rotate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "grace_period_hours": 24
  }),
});
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:
# {keyId} 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(
    "POST",
    "https://evalguard.ai/api/v1/api-keys/00000000-0000-0000-0000-000000000000/rotate",
    headers=headers,
    json={
    "grace_period_hours": 24
},
)
print(response.status_code, response.json())

Go

package main

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

// {keyId} is shown with an EXAMPLE value — replace it with real values.
func main() {
	body := strings.NewReader(`{"grace_period_hours":24}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/api-keys/00000000-0000-0000-0000-000000000000/rotate", 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

400401403404429500

Other API Keys endpoints