Skip to content

Authentication ​

All DMOps.ai API requests must be authenticated with an API key.


API key authentication ​

Pass your API key in the X-API-Key header on every request:

bash
curl -H "X-API-Key: your_api_key" https://<tenant>.app.dmops.ai/api/tasks

Getting your API key ​

Your API key is set when the tenant is provisioned. It is stored in the HERMES_ACP_API_KEY environment variable on the server.

For managed tenants, your admin can provide the API key via the Settings → API Keys panel (coming soon). For now, contact your DMOps.ai tenant administrator.


Web UI authentication ​

The web UI uses HTTP Basic Auth. When you open the dashboard in your browser, you'll be prompted for a username and password. These are separate from the API key.

Default credentials are set during provisioning. Change them in Settings → Users.


Security best practices ​

  • Never commit API keys to source control
  • Rotate keys if they are ever exposed
  • Use environment variables to inject the key into your application:
bash
export DMOPS_API_KEY="your_api_key"
curl -H "X-API-Key: $DMOPS_API_KEY" https://<tenant>.app.dmops.ai/api/tasks
  • Restrict key scope — future versions will support scoped keys (read-only, task-only, etc.)

Master key (integration credentials) ​

The HERMES_ACP_MASTER_KEY is a separate key used to encrypt and decrypt integration credentials (API keys for Jira, Salesforce, etc.). This key is never exposed to the API or UI — it is a server-side secret only.

If you are self-hosting, set this key in your .env file and keep it secure. Losing this key means integration credentials cannot be decrypted.