Lockally Encryption API

End-to-end encryption key management

GitHub OpenAPI

Operations 6

POST /v1/encryption/keys Upload an encryption key pair #
GET /v1/encryption/keys/lookup Batch-lookup public keys by email #
GET /v1/encryption/keys/{email} Get encryption key for a mailbox #
POST /v1/encryption/keys/rotate Re-seal an encryption key under a new password #
GET /v1/encryption/status End-to-end encryption status for the workspace #
POST /v1/encryption/recovery Store an encryption recovery blob #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/lockally-com:lockally-com-encryption-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lockally-com-encryption-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: lockally control plane Encryption API
  version: 0.1.0
  summary: REST API for managing tenants, domains, mailboxes, and outbound mail
  description: '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__`,

    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

    `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`.'
  contact:
    name: lockally support
    email: support@lockally.com
  license:
    name: AGPL-3.0-only OR LicenseRef-LOC-Commercial
    identifier: AGPL-3.0-only
servers:
- url: https://api.lockally.com
  description: Production
- url: http://127.0.0.1:8081
  description: Local development / spike
security:
- bearerAuth: []
tags:
- name: Encryption
  description: End-to-end encryption key management
paths:
  /v1/encryption/keys:
    post:
      tags:
      - Encryption
      operationId: createEncryptionKey
      x-required-scope: mailboxes:write
      summary: Upload an encryption key pair
      description: 'Only the mailbox''s own webmail session may call this; an API key is refused with 403. The private key is sealed under that mailbox''s password, which an administrator never has. `mailbox_email`, if sent, must be the caller''s own mailbox. A mailbox that already has a key is starting over: the old key is kept inactive, not destroyed, and the new one starts without a recovery code.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - public_key
              - encrypted_private_key
              properties:
                mailbox_email:
                  type: string
                  format: email
                public_key:
                  type: string
                encrypted_private_key:
                  type: string
                kdf_params:
                  type: object
      responses:
        '201':
          description: Key pair stored
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  mailbox_id:
                    type: string
                    format: uuid
                  created_at:
                    type: string
                    format: date-time
                  replaced_old:
                    type: boolean
        '400':
          $ref: '#/components/responses/ProblemBadRequest'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/encryption/keys/lookup:
    get:
      tags:
      - Encryption
      operationId: batchLookupPublicKeys
      x-required-scope: mailboxes:read
      summary: Batch-lookup public keys by email
      parameters:
      - name: emails
        in: query
        required: true
        schema:
          type: string
        description: Comma-separated list of email addresses
      responses:
        '200':
          description: Public keys for requested emails
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        email:
                          type: string
                        public_key:
                          type: string
                          nullable: true
                        key_id:
                          type: string
                          format: uuid
                          nullable: true
        '400':
          $ref: '#/components/responses/ProblemBadRequest'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/encryption/keys/{email}:
    parameters:
    - name: email
      in: path
      required: true
      schema:
        type: string
        format: email
    get:
      tags:
      - Encryption
      operationId: getEncryptionKey
      x-required-scope: mailboxes:read
      summary: Get encryption key for a mailbox
      description: Anyone in the workspace gets the public key. The mailbox's own webmail session also gets its sealed private key, its sealed recovery copy and the recovery state.
      responses:
        '200':
          description: Encryption key details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  email:
                    type: string
                    format: email
                  public_key:
                    type: string
                  encrypted_private_key:
                    type: string
                  kdf_params:
                    type: object
                  version:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  rotated_at:
                    type: string
                    format: date-time
                    nullable: true
                  has_recovery:
                    type: boolean
                  recovery_set_at:
                    type: string
                    format: date-time
                    nullable: true
                  recovery_blob:
                    type: string
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
        '404':
          $ref: '#/components/responses/ProblemNotFound'
  /v1/encryption/keys/rotate:
    post:
      tags:
      - Encryption
      operationId: rotateEncryptionKey
      x-required-scope: mailboxes:write
      summary: Re-seal an encryption key under a new password
      description: Only the mailbox's own webmail session may call this; an API key is refused with 403. The private key is sealed under that mailbox's password, which an administrator never has. `mailbox_email`, if sent, must be the caller's own mailbox. The key pair does not change, so every message stays readable.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - encrypted_private_key
              properties:
                mailbox_email:
                  type: string
                  format: email
                encrypted_private_key:
                  type: string
                kdf_params:
                  type: object
      responses:
        '204':
          description: Key rotated
        '400':
          $ref: '#/components/responses/ProblemBadRequest'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/encryption/status:
    get:
      tags:
      - Encryption
      operationId: getEncryptionStatus
      x-required-scope: mailboxes:read
      summary: End-to-end encryption status for the workspace
      description: 'For administrators: whether the add-on is on, and for each mailbox whether it has a key and a recovery code. Carries no key material.'
      responses:
        '200':
          description: Status
          content:
            application/json:
              schema:
                type: object
                properties:
                  eligible:
                    type: boolean
                  active:
                    type: boolean
                  mailboxes:
                    type: array
                    items:
                      type: object
                      properties:
                        email:
                          type: string
                          format: email
                        has_key:
                          type: boolean
                        key_created_at:
                          type: string
                          format: date-time
                        has_recovery:
                          type: boolean
                        recovery_set_at:
                          type: string
                          format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/encryption/recovery:
    post:
      tags:
      - Encryption
      operationId: createEncryptionRecovery
      x-required-scope: mailboxes:write
      summary: Store an encryption recovery blob
      description: Only the mailbox's own webmail session may call this; an API key is refused with 403. The private key is sealed under that mailbox's password, which an administrator never has. `mailbox_email`, if sent, must be the caller's own mailbox. The blob is the private key sealed under a recovery code the browser generated; the code itself is never sent. Replaces any earlier one.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - recovery_blob
              properties:
                mailbox_email:
                  type: string
                  format: email
                recovery_blob:
                  type: string
      responses:
        '204':
          description: Recovery blob stored
        '400':
          $ref: '#/components/responses/ProblemBadRequest'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
components:
  responses:
    ProblemForbidden:
      description: API key lacks the required scope.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemBadRequest:
      description: Malformed request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemUnauthorized:
      description: Missing, malformed, or invalid API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemNotFound:
      description: Resource not found under the calling tenant.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    Problem:
      description: RFC 9457 problem-details document.
      type: object
      required:
      - type
      - status
      - title
      properties:
        type:
          type: string
          format: uri
          default: about:blank
        status:
          type: integer
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
          format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: lk_live_<prefix>_<secret>
      description: API key, format `lk_live_<8-char-prefix>_<32-char-secret>`.
    oauth2:
      type: oauth2
      description: 'OAuth 2.1 (authorization code + PKCE). The access token is sent as the

        `Authorization: Bearer` credential, exactly like an API key, so any SDK

        that accepts a bearer token works with OAuth. Discovery:

        `/.well-known/oauth-authorization-server`.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://api.lockally.com/oauth/authorize
          tokenUrl: https://api.lockally.com/oauth/token
          scopes:
            inboxes:read: Read agent-accessible mailboxes and threads
            inboxes:write: Send and act on agent-accessible mailboxes