GEgetaxonflow
Simulation

Simulate policies (dry run)

Run all active policies against the provided input as a dry run — no audit writes and no policy actions are applied.

Evaluation tier and above — requires an Evaluation or Enterprise license. Daily simulation quotas apply per tier (unlimited on Enterprise); exceeding the quota returns 429.

post/api/v1/policies/simulate

Request

Headers

X-Tenant-IDstring required
Example:tenant_abc123

Tenant identifier for multi-tenancy isolation. When calling through the Agent (recommended), this header is stamped automatically from the authenticated client — you do not set it yourself. Required only on direct Orchestrator calls (internal deployments).

Request body

querystring required

Input to evaluate against all active policies

request_typestring

Type of request being simulated (defaults to "simulation")

contextobject

Additional context for evaluation

Example request

{
  "user": {
    "email": "analyst@company.com",
    "role": "analyst"
  }
}

Response

Simulation results

allowedboolean

Whether the input would be allowed

applied_policiesstring[]

Names of policies that matched

risk_scorenumber float
required_actionsstring[]
processing_time_msinteger
total_policiesinteger

Number of active policies visible to the calling tenant — its own plus the shared global/default baseline.

CHANGED: this previously counted every active policy in the deployment, across all tenants, which disclosed the deployment-wide policy count to every caller. Integrations that treated this as a deployment-level total will now see a smaller, tenant-scoped number.

dry_runboolean

Always true — no actions were applied

simulated_atstring date-time
tierstring

License tier the simulation ran under

Changes

No recorded changes to this operation across all 1 revision of this API.