The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.

Required Ruby Version

>= 2.7

Authors

OpenAPI-Generator

Versions

  1. 0.3.3

    1. source

      1. 0.3.3 source October 16, 2026 (241 KB)
  2. 0.3.2

    1. source

      1. 0.3.2 source October 15, 2026 (241 KB)
  3. 0.3.1

    1. source

      1. 0.3.1 source October 15, 2026 (240 KB)
  4. 0.3.0

    1. source

      1. 0.3.0 source October 15, 2026 (236 KB)
  5. 0.2.0

    1. source

      1. 0.2.0 source October 09, 2026 (222 KB)
Show all versions (6 total)

SHA 256 checksum

← Previous version