Skip to content
POST/api/v1/shadow-ai/policy

Set a shadow-AI per-domain policy override

Upserts a per-domain policy (approved/blocked/pending) and propagates to existing sightings. Admin role required. domain + status required; projectId resolvable from body/query/api-key; rationale optional.

Authentication

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

Request body required

Example

{
  "domain": "<Valid hostname (3-253 chars, [a-z0-9.-])>",
  "status": "approved",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "rationale": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "domain",
        "status"
      ],
      "properties": {
        "domain": {
          "type": "string",
          "description": "Valid hostname (3-253 chars, [a-z0-9.-])."
        },
        "status": {
          "type": "string",
          "enum": [
            "approved",
            "blocked",
            "pending"
          ]
        },
        "projectId": {
          "type": "string",
          "format": "uuid",
          "description": "Optional — resolvable from query/body/api-key context."
        },
        "rationale": {
          "type": "string"
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Policy set — {policy}.
400(no description)
401(no description)
403Forbidden — admin role required.
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/shadow-ai/policy \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "domain": "<Valid hostname (3-253 chars, [a-z0-9.-])>", "status": "approved", "projectId": "00000000-0000-0000-0000-000000000000", "rationale": "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/shadow-ai/policy", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "domain": "<Valid hostname (3-253 chars, [a-z0-9.-])>",
    "status": "approved",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "rationale": "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(
    "POST",
    "https://evalguard.ai/api/v1/shadow-ai/policy",
    headers=headers,
    json={
    "domain": "<Valid hostname (3-253 chars, [a-z0-9.-])>",
    "status": "approved",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "rationale": "string"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"domain":"<Valid hostname (3-253 chars, [a-z0-9.-])>","status":"approved","projectId":"00000000-0000-0000-0000-000000000000","rationale":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/shadow-ai/policy", 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

400401403409429500

Other Security endpoints