Azumuta’s REST API
Note: This is a highly technical article. Therefore, we recommend involving your IT department when reading this. Should you have any inquiries or requests, please contact us through support@azumuta.com - we'd be happy to assist you.
Our REST API uses standard HTTP response codes and verbs. When making a normal GET-request, the data is returned as JSON-encoded responses.
Authentication
The Azumuta API uses API keys to authenticate requests. Send the key in the X-API-Key request header (recommended). You can also use an apiKey query parameter.
Create and manage keys under Management → Devices → API. See How to Create and Manage API Keys.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Note: Your API keys are top-secret information that should never be shared with anyone outside of your company, and must never appear in browser client code.
How to Access API Documentation
The Azumuta REST API is documented in our in-app API docs:
- Click the question mark on the top right of your screen (Help).
- Click API docs.
That opens the interactive reference at /docs/api in the Azumuta platform. There you can browse endpoints for Azumuta modules and add-ons (except Dashboards).
When you are authenticated, you can live-test endpoints with the Try it out button and see the result in your Azumuta platform.
Workspace AI Primer for Developers
If you are building an integration with an AI coding assistant, start with the workspace-tailored primer rather than pasting the full OpenAPI document into your knowledge base.
Authenticated GET /api/v1/agents-azumuta.md returns a markdown file for your workspace (base URL, languages, and API conventions). Download it from the in-app API docs introduction, or request that path with your API key.
The machine-readable OpenAPI spec is available at /api/v1/spec.json (also requires your API key), or via the Swagger UI in the API docs.
MCP for AI assistants (beta)
Beta feature. Azumuta's MCP (Model Context Protocol) server lets AI assistants call permitted REST tools for your workspace. It is in beta, may still evolve, and is available by opt-in only. To enable MCP or ask questions, contact support@azumuta.com.
MCP access requires the workspace MCP experiment and an API key with explicit scopes. Prefer the workspace AI primer and in-app API docs for endpoint conventions; do not paste the full OpenAPI document into a shared knowledge base.
Call the API from Server-Side Integrations
Call the Azumuta REST API from server-side integrations only. Hold the API key on your server or integration layer - not in operator browsers or other client-side code.