# Lockally Migrations API

**Canonical:** https://apis.io/apis/lockally-com/lockally-com-migrations-api/  
**Provider:** Lockally — https://apis.io/providers/lockally-com/  
**Base URL:** https://api.lockally.com  
**Documentation:** https://developers.lockally.com

Lockally Migrations API is one of 30 APIs that [Lockally](https://apis.io/providers/lockally-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Migrations. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

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

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/lockally-com/openapi/lockally-com-migrations-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/lockally-com/json-schema/lockally-com-migration-mailbox-schema.json

## Other Lockally APIs (12)

- [Lockally Add Ons API](https://apis.io/apis/lockally-com/lockally-com-add-ons-api/)
- [Lockally Admin API](https://apis.io/apis/lockally-com/lockally-com-admin-api/)
- [Lockally Admins API](https://apis.io/apis/lockally-com/lockally-com-admins-api/)
- [Lockally Agents API](https://apis.io/apis/lockally-com/lockally-com-agents-api/)
- [Lockally AI API](https://apis.io/apis/lockally-com/lockally-com-ai-api/)
- [Lockally Aliases API](https://apis.io/apis/lockally-com/lockally-com-aliases-api/)
- [Lockally API Keys API](https://apis.io/apis/lockally-com/lockally-com-api-keys-api/)
- [Lockally Billing API](https://apis.io/apis/lockally-com/lockally-com-billing-api/)
- [Lockally Calendars API](https://apis.io/apis/lockally-com/lockally-com-calendars-api/)
- [Lockally Contact Lists API](https://apis.io/apis/lockally-com/lockally-com-contact-lists-api/)
- [Lockally Contacts API](https://apis.io/apis/lockally-com/lockally-com-contacts-api/)
- [Lockally Dashboard API](https://apis.io/apis/lockally-com/lockally-com-dashboard-api/)

## Tags

Migrations

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/lockally-com` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/lockally-com/lockally-com-migrations-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/lockally-com/.
