Skip to content
deedglassdocs

Dry-run one action against a policy

POST
/v1/policies/evaluate
curl --request POST \
  --url http://127.0.0.1:8080/v1/policies/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Deedglass-Version: 2026-10-01' \
  --data '{ "input": { "tool": "postgres.execute", "sql": "DELETE FROM public.orders" }, "explain": true }'

Evaluates one case input against the org’s active policies (the default), a stored version or a source, and returns the decision with its facts and, with explain, the trace. When a shadow policy is active, shadow holds its decision too. It never reserves usage and writes nothing: usage counts as zero unless the input gives it. An agent.id from another org is 404 not_found; leave it out to use a local agent. Limited to 60 requests a minute per person or key (429 rate_limited), with a 2 s timeout and bodies up to 1 MiB. Idempotency-Key is ignored. A Console session (viewer and up, with the Deedglass-CSRF header) or an org admin key (admin scope); agent keys get 403 insufficient_scope (“Agents cannot read or test policies. Use the Console or an admin key.”).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Deedglass-Version
string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

The API version (YYYY-MM-DD). Leave it out to use your org’s pinned version (public routes use the latest). An unknown version is 400 api_version_invalid.

Deedglass-CSRF
string

Needed when the request uses a Console session (it changes state); without it the answer is 403 csrf_failed. Not sent with an API key.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
policy
One of:
string
Allowed value: active
input
required

The action, in the case-input format (docs/POLICY_LANGUAGE.md §6.2): tool, args (or the sql shorthand), and optionally agent, org, user, session, request, time, usage and anomaly.

object
explain

Include the trace.

boolean
Example
{
  "input": {
    "tool": "postgres.execute",
    "sql": "DELETE FROM public.orders"
  },
  "explain": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The decision.

Media typeapplication/json

A dry-run decision. Nothing ran and no usage was reserved. shadow is the shadow policy’s decision for the same input, when one is active.

object
object
required
string
Allowed value: policy_decision
decision
required
string
Allowed values: allow deny require_approval
code
required
string | null
Allowed values: policy_denied approval_required budget_exceeded agent_stopped agent_suspended org_stopped policy_unavailable
source
required
string
Allowed values: stop budget rule default builtin
rule_id
required
string | null
rule_line
required
integer | null
>= 1
reason
required
string | null
message
required

What the agent would see.

string
approval
required
Any of:

Who approves and for how long.

object
approvers
required

role:owner, role:admin or user:<email>, sorted.

Array<string>
required
required
integer
>= 1
expires_in
required

Seconds.

integer
verify
required
string | null
Allowed values: L0 L1 L2
notify
required
Array<string>
budget
required

The budget that decided; null otherwise.

object
id
required
string
per
required
string
Allowed values: agent org
window
required
string
Allowed values: minute hour day
limit
required
integer
used
required
integer
projected

Used plus this action’s measured amount

integer
unit
required

calls, or a currency in minor units.

string
resets_at
required
string format: date-time
retry_after_s
required
integer
policy
required

The policy that decided. id, version and version_id are null for a source sent with the request.

object
id
required
string | null
name
required
string
version
required
integer | null
>= 1
version_id
required
string | null
version_hash
required
string
mode
required
string
Allowed values: enforce shadow
shadow
required
Any of:

A dry-run decision. Nothing ran and no usage was reserved. shadow is the shadow policy’s decision for the same input, when one is active. The full PolicyDecision schema is in openapi.yaml.

object
facts
required

The derived facts the rules saw. sql is the SQL classifier’s report on args.sql (docs/SQLGUARD.md); time is the decision instant in the org’s time zone (now, hour, minute, weekday, date).

object
sql
required
object
time
required
object
trace
required

With explain only; otherwise empty.

Array<object>

One line of an explain trace. The full PolicyTraceStep schema is in openapi.yaml.

object
errors
required
Array<string>
sqlguard_version
required
string
evaluated_in_us
required
integer
>= 1
Example
{
  "object": "policy_decision",
  "decision": "allow",
  "code": "policy_denied",
  "source": "stop",
  "verify": "L0",
  "budget": {
    "per": "agent",
    "window": "minute"
  },
  "policy": {
    "mode": "enforce"
  }
}

Headers

Section titled “Headers”
Deedglass-Request-Id
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

default

Section titled “default”

An error. Every error has this envelope; doc_url explains the code.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error
code
required
string
Allowed values: invalid_api_key api_key_revoked api_key_expired agent_suspended agent_stopped org_stopped insufficient_scope policy_denied approval_required approval_expired budget_exceeded intent_required intent_invalid intent_replay tool_unknown connector_unavailable upstream_error timeout rate_limited idempotency_conflict validation_failed not_found conflict internal_error authentication_required method_not_allowed request_too_large unsupported_media_type invalid_json api_version_invalid idempotency_key_invalid idempotency_key_in_use service_unavailable session_expired csrf_failed insufficient_role login_link_invalid login_code_invalid last_owner policy_unavailable policy_invalid credentials_missing destination_blocked vault_unavailable upstream_auth_failed upstream_not_found upstream_rate_limited response_too_large statement_refused row_limit_exceeded database_role_unsafe database_not_ready witness_not_configured approval_decided already_countersigned approver_not_eligible self_approval approval_needs_person context_changed approval_unsatisfiable approval_link_invalid approval_link_review_only approver_unmapped stripe_live_key_refused stripe_livemode_detected upstream_approval_pending schedule_needs_approval action_executing from_denied undo_unavailable undo_plan_stale already_undone undo_conflict replay_too_large replay_window_invalid suggestion_stale shadow_slot_taken suggestion_decided observe_not_enabled pro_required
message
required

One or more calm sentences with the next step.

string
param
required

The request field, query parameter or header the error is about.

string | null
request_id
required
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/
doc_url
required
string format: uri
diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

One finding about a policy file, with its position and the next step. Codes are stable and listed in docs/POLICY_ERRORS.md. In the policy_invalid error envelope each diagnostic also carries object: policy_diagnostic. The full PolicyDiagnostic schema is in openapi.yaml.

object
action

One agent action. Its sections mirror the deed’s. status is the one field an agent needs; state is the exact lifecycle state (docs/GATE.md). The Gate’s own responses (POST /v1/actions and its result report) add execution.result and witness.reasons; lists leave both out. The full Action schema is in openapi.yaml.

object
checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object
Example
{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "There's no endpoint at GET /v1/helth. Did you mean /v1/health?",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/not_found"
  }
}

Headers

Section titled “Headers”
Deedglass-Request-Id
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version
string

The API version this response follows.