> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.modulards.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to use the Modular DS public API

The Modular DS public API lets you connect your account with other tools and manage your websites through code, without going through the dashboard.

Its most common use is to bring Modular DS information into your own panel, such as your hosting's or your agency's, so you can manage your websites from there or show that data to your clients.

You can also build integrations with other tools, connect Modular DS to automation platforms like Zapier, Make or n8n, or write your own scripts.

Here's what you need to get started: how to create your key and what you can do with it. And if you already know your way around, you can go straight to [the API documentation, with all the endpoints and examples](https://api.docs.modulards.com/introduction).

## Create your API key

To use the API you need a key (**your access token**), which identifies each request as coming from your account.

You create it from your profile, in the ["API" tab](https://app.modulards.com/profile/api-tokens), with the "Create key" button.

When you generate it, you set two things:

* **Permissions:** "Read only", which only queries data, or "Read and write", which also lets you create, modify and run actions.
* **Expiration:** optional, in case you want the key to stop working on a specific date.

For security, **the key is shown only once**, at the moment you create it. Copy it and store it somewhere safe, because you won't be able to see it again afterwards.

If you lose it, you'll have to create a new one and update it wherever you were using it.

In the "API" tab list you can see all your keys with their permissions and creation date. From there you can change a key's permissions or revoke the one you no longer use, from its options menu.


![](https://storage.crisp.chat/users/helpdesk/website/-/a/a/5/5/aa55333f4a914000/api-keys-modular-ds_166asln.png)

## What you can do with the API

Through the API you can query most of the information you find in Modular DS, and run actions without entering the dashboard. For example:

* Websites, teams and tags: list, create, edit and connect them.
* Updates: inventory of plugins, themes and core, and installing or updating components.
* Backups: create and manage your backups.
* Uptime Monitor and SSL certificates.
* Malware scan and broken links.
* Vulnerabilities and each website's health status.
* Tasks, clients, contacts and notification settings.

## How to make requests

Every request is authenticated with your API key and shares the same base URL: `https://api.modulards.com/api/public/v1`.

The API follows the JSON:API standard, so resource URLs are predictable and every response has the same format.

In the [API documentation](https://api.docs.modulards.com/introduction) you'll find the details on authentication, pagination, filters and errors.

## Example kit

If you want to see the API in action before writing any code, there's an [example kit](https://api.docs.modulards.com/example-kit): an open-source app you can open at [examplekit.modulards.ai](https://examplekit.modulards.ai/) and use with your own key.

Each screen in the kit relies on a real API call, so it's useful both for exploring your data and for seeing how each request is built.

To try it safely, use a "Read only" key, which doesn't modify anything. The code is published on [GitHub](https://github.com/modulards/api-example-kit) in case you want to use it as a starting point for your own project.

## API or MCP?

The public API and the MCP are two ways of working with Modular DS without entering the dashboard, meant for different uses:

* The public API is for your own integrations, automations and scripts.
* The MCP is for managing your websites from an AI assistant like Claude or ChatGPT, using natural language.

If that last one is what you're after, follow the guide on [how to connect the Modular DS MCP to your AI assistant](https://help.modulards.com/en/article/how-to-connect-the-modular-ds-mcp-to-your-ai-assistant-1aancob/).

## Related articles

* [The Modular DS MCP: what it is and what you can do with it](https://help.modulards.com/en/article/the-modular-ds-mcp-what-it-is-and-what-you-can-do-with-it-1tasq73/)
* [How to connect the Modular DS MCP to your AI assistant](https://help.modulards.com/en/article/how-to-connect-the-modular-ds-mcp-to-your-ai-assistant-1aancob/)
* [Example prompts for using the Modular DS MCP](https://help.modulards.com/en/article/example-prompts-for-using-the-modular-ds-mcp-1dy2h7b/)

Do you need help with anything else? Email us at [help@modulards.com](mailto:help@modulards.com) or contact us via the support chat, and we'll be happy to help you.