Skip to content
POST/api/v1/changes

Manually log a change event

Records a change event for compliance trails — used by external automation (CI/CD pipelines, IaC apply hooks) to feed change-management evidence.

Authentication

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

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "changeType": "prompt_edit",
  "resourceType": "string",
  "resourceId": "string",
  "resourceName": "string",
  "action": "create",
  "diff": {
    "fields": [
      "string"
    ]
  },
  "summary": "string",
  "riskLevel": "low",
  "rollbackHref": "https://example.com"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "projectId": {
          "nullable": true,
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "changeType": {
          "type": "string",
          "enum": [
            "prompt_edit",
            "firewall_rule",
            "eval_suite",
            "eval_scorer",
            "guardrail",
            "feature_flag",
            "env_var",
            "api_key",
            "secret_rotation",
            "deploy",
            "workflow",
            "pipeline",
            "integration",
            "plan_change",
            "team_change",
            "manual"
          ]
        },
        "resourceType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "resourceId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "resourceName": {
          "type": "string",
          "maxLength": 500
        },
        "action": {
          "type": "string",
          "enum": [
            "create",
            "update",
            "delete",
            "rollback",
            "deploy"
          ]
        },
        "diff": {
          "type": "object",
          "properties": {
            "before": {},
            "after": {},
            "fields": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "summary": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "riskLevel": {
          "type": "string",
          "enum": [
            "low",
            "medium",
            "high",
            "critical"
          ]
        },
        "rollbackHref": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "orgId",
        "changeType",
        "resourceType",
        "resourceId",
        "action",
        "summary"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Logged.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/changes \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "changeType": "prompt_edit", "resourceType": "string", "resourceId": "string", "resourceName": "string", "action": "create", "diff": { "fields": [ "string" ] }, "summary": "string", "riskLevel": "low", "rollbackHref": "https://example.com" }'

TypeScript

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

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

const response = await client.request({
  method: "POST",
  path: "/api/v1/changes",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "changeType": "prompt_edit",
    "resourceType": "string",
    "resourceId": "string",
    "resourceName": "string",
    "action": "create",
    "diff": {
      "fields": [
        "string"
      ]
    },
    "summary": "string",
    "riskLevel": "low",
    "rollbackHref": "https://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="POST",
    path="/api/v1/changes",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "changeType": "prompt_edit",
    "resourceType": "string",
    "resourceId": "string",
    "resourceName": "string",
    "action": "create",
    "diff": {
        "fields": [
            "string"
        ]
    },
    "summary": "string",
    "riskLevel": "low",
    "rollbackHref": "https://example.com"
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","changeType":"prompt_edit","resourceType":"string","resourceId":"string","resourceName":"string","action":"create","diff":{"fields":["string"]},"summary":"string","riskLevel":"low","rollbackHref":"https://example.com"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/changes", 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

400401429

Other Compliance endpoints