OpenAPI specification
The whole API as a machine-readable OpenAPI 3 document:
https://developers.lockally.com/openapi.yaml
It is the same file the official clients are generated from, not a re-export, so what you generate from it matches what we ship.
What you can do with it
Generate a client for a language we do not publish:
npx @openapitools/openapi-generator-cli generate \
-i https://developers.lockally.com/openapi.yaml \
-g <your-language> \
-o ./lockally-client
Import it into a tool. Postman, Insomnia, Bruno and Stoplight all read it directly, which gives you every endpoint with its parameters without any copying from these pages.
Generate types only, which is often the useful half: you keep your own HTTP layer and still get the request and response shapes checked.
What it does not carry
Two responses are still untyped. GET /v1/health and
GET /v1/migrations/{id}/dns-check are declared as free-form objects, so a
generated client gives you an untyped map for those two and nothing else.
They are typed in the next client release; everything else, 183 of 185
operations, carries a schema.
Retries, pagination and webhook verification are not in it, because none
of them can be derived from a specification. A client you generate will not
retry a 429, will not follow next_cursor, and will not verify a webhook
signature: see Signature verification for the
algorithm you need.
It tracks the repository, not a release
The published file is copied from the source of truth at every docs build, so it cannot drift behind the API the way a hand-maintained copy would.
That also means it can be ahead of the published SDKs: the clients are
regenerated on their own release cycle, so a field added to the spec appears
here before it appears in lockally@x.y.z. If you are generating your own
client, that is an advantage. If you are comparing against an official one,
check its version.
Versioning
The document describes /v1. Additive changes land without warning, and
breaking ones get at least 30 days’ notice, which is the same promise the HTTP
API makes. See Versioning.