API Keys and the REST API

Programmatic access

Merlonix has a REST API you can use to manage assets, checks, alerts, clients, and status pages from your own scripts and tools. Access is controlled with API keys, available on every plan, under Settings → API keys.

Creating a key

1. Open Settings, scroll to API keys, and create a key with a name.
2. Choose an access level: Read-only (GET requests) or Read + write (GET plus POST/PUT/PATCH/DELETE).
3. The full key is shown once at creation — copy it then, because it cannot be retrieved again. If you lose it, revoke it and create a new one.

Using a key

Send the key as a bearer token on each request:

Authorization: Bearer <your-api-key>

The interactive API reference (OpenAPI) lists the available endpoints.

Managing keys

The API keys list shows each key's name, prefix, scope (read or read + write), and last-used date. Revoke a key to stop it authenticating immediately. Creating and revoking keys requires owner or admin role.