Skip to content
PATCH/api/v1/security/{scanId}

Update scan status

Authentication

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

Parameters

scanId in pathrequired
string

Request body required

Example

{
  "status": "pending"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "running",
            "passed",
            "failed",
            "error",
            "queued"
          ]
        }
      }
    }
  }
}

Response

All status codes

200Updated scan
400Bad Request — INVALID_ID, VALIDATION_ERROR.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — INSUFFICIENT_ROLE, KEY_ORG_MISMATCH, NOT_ORG_MEMBER.
404Not Found — NOT_FOUND.
409Conflict — CONFLICT.
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
500Internal Server Error — DB_ERROR.

Code samples

cURL

# {scanId} is shown with an EXAMPLE value — replace it with real values.
curl -X PATCH \
  https://evalguard.ai/api/v1/security/00000000-0000-0000-0000-000000000000 \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "pending" }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:
// {scanId} is shown with an EXAMPLE value — replace it with real values.

const res = await fetch("https://evalguard.ai/api/v1/security/00000000-0000-0000-0000-000000000000", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "pending"
  }),
});
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:
# {scanId} is shown with an EXAMPLE value — replace it with real values.

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/security/00000000-0000-0000-0000-000000000000",
    headers=headers,
    json={
    "status": "pending"
},
)
print(response.status_code, response.json())

Go

package main

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

// {scanId} is shown with an EXAMPLE value — replace it with real values.
func main() {
	body := strings.NewReader(`{"status":"pending"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/security/00000000-0000-0000-0000-000000000000", 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