> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis.md).

# 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

* [Returns All Modules](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/returns-all-modules.md)
* [Creating New Module](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/creating-new-module.md)
* [Retrieves Module Configuration](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/retrieves-module-configuration.md)
* [Updates Module Configuration](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/updates-module-configuration.md)
* [Delete the Module](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/delete-the-module.md)
* [Exporting Module in ZIP Format](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/exporting-module-in-zip-format.md)
* [Returns Hedera ID for Specific Module](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/returns-hedera-id-for-specific-module.md)
* [Import Module from ZIP File](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/import-module-from-zip-file.md)
* [Import Module from IPFS](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/import-module-from-ipfs.md)
* [Preview Module from ZIP File](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/preview-module-from-zip-file.md)
* [Preview Module from IPFS](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/preview-module-from-ipfs.md)
* [Publishing Module onto IPFS](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/publishing-module-onto-ipfs.md)
* [Validates Module](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/validates-module.md)
* [Returns Module Menu](https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis/returns-module-menu.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://guardian.hedera.com/docs/3.7.0/developer-tools-and-resources/api-reference/modules-apis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
