POST/api/v1/dlp/scan

Run a DLP scan

Scans the requested data scope for sensitive content. Returns per-finding type + location + severity.

Authentication

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

Request body required

Example

{
  "scope": {},
  "types": [
    "pii"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "scope"
      ],
      "properties": {
        "scope": {
          "type": "object"
        },
        "types": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "pii",
              "phi",
              "pci",
              "secrets",
              "credentials"
            ]
          }
        }
      }
    }
  }
}

Response

202 example

{
  "scan_id": "00000000-0000-0000-0000-000000000000"
}

All status codes

202Scan queued.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/dlp/scan \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scope": {}, "types": [ "pii" ] }'

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/dlp/scan",
  body: {
    "scope": {},
    "types": [
      "pii"
    ]
  },
});
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/dlp/scan",
    body={
    "scope": {},
    "types": [
        "pii"
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/dlp/scan", map[string]any{"scope": map[string]any{}, "types": []any{"pii"}})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401429

Other Security endpoints