For the complete documentation index, see llms.txt. This page is also available as Markdown.

Dry Run Mode using APIs

Endpoints for running a Guardian policy in dry-run (simulation) mode. Dry-run mode allows testing a policy workflow with virtual users and documents without making any Hedera transactions or persistent changes.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Standard Registry role required.


Method
Endpoint
Description
Auth Required

GET

/api/v1/policies/{policyId}/dry-run/users

Returns all virtual users for the dry-run instance

Yes

POST

/api/v1/policies/{policyId}/dry-run/user

Creates a new virtual user

Yes

POST

/api/v1/policies/{policyId}/dry-run/login

Logs in as a virtual user

Yes

POST

/api/v1/policies/{policyId}/dry-run/restart

Restarts the policy dry-run execution

Yes

GET

/api/v1/policies/{policyId}/dry-run/transactions

Returns the list of dry-run transactions

Yes

GET

/api/v1/policies/{policyId}/dry-run/artifacts

Returns the list of dry-run artifacts

Yes

GET

/api/v1/policies/{policyId}/dry-run/ipfs

Returns the list of IPFS files created in dry-run

Yes

DELETE

/api/v1/policies/{policyId}/draft

Returns the policy to draft/editing state

Yes

GET

/api/v1/policies/{policyId}/save-points

Returns all savepoints for the dry-run session

Yes

POST

/api/v1/policies/{policyId}/save-points

Creates a new savepoint

Yes

GET

/api/v1/policies/{policyId}/save-points/{savepointId}

Returns the savepoint state

Yes

POST

/api/v1/policies/{policyId}/save-points/{savepointId}

Restores a savepoint

Yes

DELETE

/api/v1/policies/{policyId}/save-points/{savepointId}

Deletes a savepoint

Yes

Endpoints

Was this helpful?