Reference

The API reference in your realm

The HTTP API, Terraform, Ansible and MCP are documented in your realm's Docs window, at the versions it runs.

The HTTP API reference, the OpenTofu and Terraform provider, the Ansible collection and the MCP server are documented in your realm’s Docs window, not here. Each module brings its own pages, and its API reference is generated from the specs it runs, so what you read is exactly what your realm accepts, at its running version.

Open Docs from the start menu, or press ? in any window’s title bar for the page about that window.
Link to a page with /?open=docs:view&page=<module>/<page>, for example /?open=docs:view&page=edge/http-api.
Before you have an account, an operator can let the sign-in page open Docs read-only with the customer pages.
Connect an AI agent to the MCP server at https://<realm>/mcp, with an API key as the bearer token. Its page in Docs (mcp/mcp) has the details.

This site covers everything around a realm: installing it, adding servers, updates, backups and keeping it running. The velrix command stays here, because it is what an operator uses while a realm is down.

Directory sync: Entra ID and Okta

Let your company directory add, update and remove the people in your organisation over SCIM, so that someone who leaves loses access everywhere at once.

The velrix command

[object Object]