Skip to content
PATCH/api/v1/incidents

Update an incident

Updates an incident by id (404 if not found; 403 if not an org member). camelCase fields.

Authentication

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

Request body required

Example

{
  "id": "string",
  "status": "string",
  "statusDetails": "string",
  "rootCause": "string",
  "remediation": "string",
  "assignedTo": "string",
  "severity": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "status": {
          "type": "string",
          "maxLength": 50
        },
        "statusDetails": {
          "type": "string",
          "maxLength": 5000
        },
        "rootCause": {
          "type": "string",
          "maxLength": 20000
        },
        "remediation": {
          "type": "string",
          "maxLength": 20000
        },
        "assignedTo": {
          "type": "string",
          "maxLength": 200
        },
        "severity": {
          "type": "string",
          "maxLength": 50
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": {}
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

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

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/incidents \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "id": "string", "status": "string", "statusDetails": "string", "rootCause": "string", "remediation": "string", "assignedTo": "string", "severity": "string" }'

TypeScript

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

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

const response = await client.request({
  method: "PATCH",
  path: "/api/v1/incidents",
  body: {
    "id": "string",
    "status": "string",
    "statusDetails": "string",
    "rootCause": "string",
    "remediation": "string",
    "assignedTo": "string",
    "severity": "string"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

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

response = client.request(
    method="PATCH",
    path="/api/v1/incidents",
    body={
    "id": "string",
    "status": "string",
    "statusDetails": "string",
    "rootCause": "string",
    "remediation": "string",
    "assignedTo": "string",
    "severity": "string"
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"id":"string","status":"string","statusDetails":"string","rootCause":"string","remediation":"string","assignedTo":"string","severity":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/incidents", 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

400401403404429

Other Monitoring endpoints