Skip to content
PATCH/api/v1/data-discovery/findings

Update finding state

Updates one `data_findings` row addressed by `?id=` (400 if absent, 404 if it matches no row). Body: `status` (one of `open`, `reviewing`, `remediated`, `false_positive`, `accepted_risk`, `expired`) and/or `resolution_notes` (up to 20,000 chars). Moving to `remediated`, `false_positive` or `accepted_risk` also stamps `resolved_at` and `resolved_by` server-side. Requires the org `admin` role and `compliance:update` — resolving a PII-discovery finding is reserved for owner/admin by the table's RLS policy, and the role gate is what holds on the API-key path where RLS is bypassed. Audit-logged.

Authentication

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

Request body required

Example

{
  "status": "open",
  "resolution_notes": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "open",
            "reviewing",
            "remediated",
            "false_positive",
            "accepted_risk",
            "expired"
          ]
        },
        "resolution_notes": {
          "type": "string",
          "maxLength": 20000
        }
      },
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Updated.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
404(no description)
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/data-discovery/findings \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "open", "resolution_notes": "string" }'

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/data-discovery/findings", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "open",
    "resolution_notes": "string"
  }),
});
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(
    "PATCH",
    "https://evalguard.ai/api/v1/data-discovery/findings",
    headers=headers,
    json={
    "status": "open",
    "resolution_notes": "string"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"status":"open","resolution_notes":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/data-discovery/findings", 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

400401403404409429500

Other Security endpoints