Skip to content

Preview a V1 gateway policy decision without runtime mutation.

POST
/v1/policies/simulate
object
schemaVersion
required
simulationId
required
string
>= 1 characters
actor
required
Any of:
object
tenantId
string
>= 1 characters
environmentId
string
>= 1 characters
clientSurfaceId
string
>= 1 characters
userId
required
string
>= 1 characters
groupIds
Array<string>
agentId
string
>= 1 characters
agentInstanceId
string
>= 1 characters
humanDelegatorId
string
>= 1 characters
serviceId
string
>= 1 characters
workloadId
string
>= 1 characters
target
required
One of:
object
environmentId
string
>= 1 characters
serverId
required
string
>= 1 characters
apiSourceId
string
>= 1 characters
operationId
string
>= 1 characters
connectorId
string
>= 1 characters
toolId
string
>= 1 characters
candidatePolicyVersion
required
string
>= 1 characters
activePolicyVersion
string
>= 1 characters
credentialMode
required
Allowed values: none service_account user_delegated agent_scoped workload_mapped
credentialBindingId
string
>= 1 characters

Simulation result with no secret material or side effects.

object
schemaVersion
required
simulationId
required
string
>= 1 characters
decision
required
Allowed values: allow deny
reason
required
string
>= 1 characters
policyVersion
required
string
>= 1 characters
ruleId
string
>= 1 characters
matchedRule
object
ruleId
required
string
>= 1 characters
effect
required
Allowed values: allow deny
reason
required
string
>= 1 characters
credentialMode
required
Allowed values: none service_account user_delegated agent_scoped workload_mapped
sideEffects
required
diagnosis
required
object
reason
required
string
>= 1 characters
machineReason
required
ruleId
string
>= 1 characters
failingConstraints
required
Array<string>
remediation
string
>= 1 characters

Type set in Geist, Source Serif 4, and Departure Mono.