Tools APIs

Endpoints for creating, managing, importing, exporting, and publishing Guardian policy tools. Tools are reusable policy components that encapsulate specific functionality.

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

Permission: Standard Registry role required for write operations.


Method
Endpoint
Description
Auth Required

GET

/api/v1/tools

Returns all tools

Yes

POST

/api/v1/tools

Creates a new tool

Yes

GET

/api/v1/tools/{id}

Returns the tool configuration

Yes

PUT

/api/v1/tools/{id}

Updates the tool configuration

Yes

DELETE

/api/v1/tools/{id}

Deletes a tool

Yes

GET

/api/v1/tools/{id}/export/file

Exports a tool as a ZIP file

Yes

GET

/api/v1/tools/{id}/export/message

Returns the tool Hedera message ID

Yes

POST

/api/v1/tools/import/file

Imports a tool from a ZIP file

Yes

POST

/api/v1/tools/import/message

Imports a tool from an IPFS message ID

Yes

POST

/api/v1/tools/import/file/preview

Previews a tool from a ZIP file

Yes

POST

/api/v1/tools/import/message/preview

Previews a tool from an IPFS message ID

Yes

PUT

/api/v1/tools/{id}/publish

Publishes a tool to IPFS

Yes

POST

/api/v1/tools/push

Creates a new tool asynchronously

Yes

POST

/api/v1/tools/{id}/validate

Validates a tool

Yes

GET

/api/v1/tools/menu/all

Returns the tools available in the menu

Yes

Endpoints

Last updated

Was this helpful?