Lockally Migrations API

Email migration from external providers (IMAP, Google, Microsoft)

GitHub OpenAPI

Operations 21

POST /v1/migrations/credentials Store a migration credential #
GET /v1/migrations/credentials List migration credentials #
DELETE /v1/migrations/credentials/{id} Delete a migration credential #
POST /v1/migrations Create a migration #
GET /v1/migrations List migrations #
GET /v1/migrations/{id} Get a migration #
PATCH /v1/migrations/{id} Update a migration #
DELETE /v1/migrations/{id} Delete a migration #
POST /v1/migrations/{id}/discover Discover source mailboxes #
POST /v1/migrations/{id}/map Map source to destination mailboxes #
POST /v1/migrations/{id}/start Start the migration #
POST /v1/migrations/{id}/cancel Cancel a running migration #
POST /v1/migrations/{id}/delta-sync Run a delta sync #
POST /v1/migrations/{id}/final-sync Run the final sync before cutover #
POST /v1/migrations/{id}/validate Validate migrated data #
POST /v1/migrations/{id}/retry Retry a failed or cancelled migration #
GET /v1/migrations/{id}/progress Get migration progress #
GET /v1/migrations/{id}/mailboxes List migration mailboxes #
PATCH /v1/migrations/{id}/mailboxes/{mbxId} Update a migration mailbox #
GET /v1/migrations/{id}/events List migration events #
GET /v1/migrations/{id}/dns-check Check DNS readiness for cutover #

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-migrations-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-migrations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: lockally control plane Migrations 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:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://artifacts.apis.io/lockally-com/openapi/lockally-com-migrations-api-openapi.yml