> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dezerx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Module API

> Endpoints added by modules, with API key access and optional public read only endpoints.

Modules can add their own endpoints to the API. They all follow the same rules as the core API: the same key, the same response envelope and the same error format.

## Two kinds of endpoints

| | Key endpoints | Public endpoints |
| - | - | - |
| Path | `/api/application/modules/<module>/...` | `/api/public/modules/<module>/...` |
| Auth | API key with the module permission | None |
| Content | Everything the permission allows, including drafts, scheduled and member only content where the module has it | Only what an anonymous visitor can see on your site |
| Rate limit | None per key | 60 requests per minute per IP, per module |
| Caching | None | 60 seconds, cleared as soon as an admin saves something |
| Available for | Blog, News, Knowledge Base, Status, Forms, Affiliates | Blog, News, Knowledge Base, Status |

Use the public endpoints from a browser or a static site, for example to show your latest blog posts or your status on a landing page. They send CORS headers, so `fetch()` from another domain works:

```js theme={null}
const response = await fetch('https://billing.example.com/api/public/modules/blog/posts?per_page=3');
const { data } = await response.json();
```

Use key endpoints from your own servers, and never put an API key in browser code.

## Permissions

Every module that ships endpoints adds its own row to the API key editor in **Developers, API keys**, for example **Blog API** or **Status API**, with a **Module** badge. Read only modules show an **Allowed** checkbox. The row only appears while the module is enabled. Disabling a module keeps the permission on existing keys, so they work again when you turn it back on.

| Module | Permissions |
| - | - |
| Blog | `modules.blog.posts.read` |
| News | `modules.news.posts.read` |
| Knowledge Base | `modules.knowledgebase.articles.read` |
| Status | `modules.status.read` |
| Forms | `modules.forms.forms.read`, `modules.forms.submissions.read` |
| Affiliates | `modules.affiliates.affiliates.read`, `modules.affiliates.payouts.read` |

## What the public endpoints never return

* Blog and News: drafts, scheduled posts, member only News posts, and nothing at all when the News section is set to members only.
* Knowledge Base: inactive articles, and articles in inactive categories.
* Status: monitor host names or check targets, disabled components, who created an incident.
* Forms and Affiliates have no public endpoints, because their data is private.

The public endpoints also have no side effects: reading a post through the API does not count as a view.

## Build your own

Module authors add endpoints with a few lines of code. See [API endpoints in the addon tutorial](https://docs.dezerx.com/extensions/tutorials/addons.md#api-endpoints).

## Turning the public endpoints off

**Developers, API keys** has a **Public module API** switch, on by default. When it is off, every `/api/public/modules/...` endpoint returns `404 not_found`. Key endpoints keep working.

## Deprecated module endpoints

Before the module API, some modules shipped their own keyless routes. They still work so existing integrations do not break, but they are deprecated: they keep the old `{"success": true, "data": ...}` envelope, have no pagination and will not get new fields. They are listed under **Deprecated endpoints** in this section.

| Deprecated | Use instead |
| - | - |
| `GET /api/blogs` | `GET /api/public/modules/blog/posts` |
| `GET /api/v1/news/latest` | `GET /api/public/modules/news/posts?per_page=10` |
| `GET /api/v1/news` | `GET /api/public/modules/news/posts` |
| `GET /api/v1/news/{slug}` | `GET /api/public/modules/news/posts/{post}` |
| `GET /api/status` | `GET /api/public/modules/status/components` plus `/incidents` and `/maintenances` |
| `GET /api/status/summary` | `GET /api/public/modules/status/summary` |
| `GET /api/status/{id}` | `GET /api/public/modules/status/components/{component}` |

`GET /api/v1/news` used to return drafts, scheduled and members only posts. Since 2026.11 it only returns published posts visible to everyone. The deprecated endpoints are not affected by the Public module API switch.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.