Skip to main content
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

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:
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.

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.

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. 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.