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

Update source config

Updates source connection params or scan schedule.

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",
  "name": "string",
  "config": {},
  "vault_entry_id": "string",
  "classifier_mode": "dlp_only",
  "sample_size_per_object": 1,
  "scan_schedule": "string",
  "enabled": false
}
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": {
          "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)$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "config": {
          "type": "object",
          "additionalProperties": {}
        },
        "vault_entry_id": {
          "type": "string",
          "maxLength": 200
        },
        "classifier_mode": {
          "type": "string",
          "enum": [
            "dlp_only",
            "dlp_plus_llm",
            "llm_only"
          ]
        },
        "sample_size_per_object": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000000
        },
        "scan_schedule": {
          "nullable": true,
          "type": "string",
          "maxLength": 200
        },
        "enabled": {
          "type": "boolean"
        }
      },
      "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)
429(no description)

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/data-discovery/sources \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "name": "string", "config": {}, "vault_entry_id": "string", "classifier_mode": "dlp_only", "sample_size_per_object": 1, "scan_schedule": "string", "enabled": false }'

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/data-discovery/sources",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "config": {},
    "vault_entry_id": "string",
    "classifier_mode": "dlp_only",
    "sample_size_per_object": 1,
    "scan_schedule": "string",
    "enabled": false
  },
});
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/data-discovery/sources",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "config": {},
    "vault_entry_id": "string",
    "classifier_mode": "dlp_only",
    "sample_size_per_object": 1,
    "scan_schedule": "string",
    "enabled": False
},
)
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","name":"string","config":{},"vault_entry_id":"string","classifier_mode":"dlp_only","sample_size_per_object":1,"scan_schedule":"string","enabled":false}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/data-discovery/sources", 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 Security endpoints