Modules APIs

Endpoints for creating, managing, importing, exporting, and publishing Guardian policy modules. Modules are reusable policy components that can be shared across policies.

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

Permission: Standard Registry role required for write operations.


Method
Endpoint
Description
Auth Required

GET

/api/v1/modules

Returns all modules

Yes

POST

/api/v1/modules

Creates a new module

Yes

GET

/api/v1/modules/{uuid}

Returns the module configuration

Yes

PUT

/api/v1/modules/{uuid}

Updates the module configuration

Yes

DELETE

/api/v1/modules/{uuid}

Deletes a module

Yes

GET

/api/v1/modules/{uuid}/export/file

Exports a module as a ZIP file

Yes

GET

/api/v1/modules/{uuid}/export/message

Returns the module Hedera message ID

Yes

POST

/api/v1/modules/import/file

Imports a module from a ZIP file

Yes

POST

/api/v1/modules/import/message

Imports a module from an IPFS message ID

Yes

POST

/api/v1/modules/import/file/preview

Previews a module from a ZIP file

Yes

POST

/api/v1/modules/import/message/preview

Previews a module from an IPFS message ID

Yes

PUT

/api/v1/modules/{uuid}/publish

Publishes a module to IPFS

Yes

POST

/api/v1/modules/{uuid}/validate

Validates a module configuration

Yes

GET

/api/v1/modules/menu

Returns the available modules menu

Yes

Endpoints

Last updated

Was this helpful?