[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs:\u002Fdocs\u002Freference\u002Fin-your-realm":3,"docs:nav":94,"docs:surround:\u002Fdocs\u002Freference\u002Fin-your-realm":304},{"id":4,"title":5,"body":6,"description":84,"extension":85,"launchGate":86,"meta":87,"navigation":88,"path":89,"seo":90,"stem":91,"stub":92,"__hash__":93},"docs_en\u002Fdocs\u002F5.reference\u002F1.in-your-realm.md","The API reference in your realm",{"type":7,"value":8,"toc":79},"minimark",[9,18,67],[10,11,12,13,17],"p",{},"The HTTP API reference, the OpenTofu and Terraform provider, the Ansible collection and the MCP server are documented in your realm’s ",[14,15,16],"strong",{},"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.",[19,20,21,32,47,53],"ul",{},[22,23,24,27,28,31],"li",{},[14,25,26],{},"Open Docs"," from the start menu, or press ",[14,29,30],{},"?"," in any window’s title bar for the page about that window.",[22,33,34,37,38,42,43,46],{},[14,35,36],{},"Link to a page"," with ",[39,40,41],"code",{},"\u002F?open=docs:view&page=\u003Cmodule>\u002F\u003Cpage>",", for example ",[39,44,45],{},"\u002F?open=docs:view&page=edge\u002Fhttp-api",".",[22,48,49,52],{},[14,50,51],{},"Before you have an account,"," an operator can let the sign-in page open Docs read-only with the customer pages.",[22,54,55,58,59,62,63,66],{},[14,56,57],{},"Connect an AI agent"," to the MCP server at ",[39,60,61],{},"https:\u002F\u002F\u003Crealm>\u002Fmcp",", with an API key as the bearer token. Its page in Docs (",[39,64,65],{},"mcp\u002Fmcp",") has the details.",[10,68,69,70,78],{},"This site covers everything around a realm: installing it, adding servers, updates, backups and keeping it running. The ",[71,72,74,77],"a",{"href":73},"\u002Fdocs\u002Freference\u002Fcli",[39,75,76],{},"velrix"," command"," stays here, because it is what an operator uses while a realm is down.",{"title":80,"searchDepth":81,"depth":82,"links":83},"",2,3,[],"The HTTP API, Terraform, Ansible and MCP are documented in your realm's Docs window, at the versions it runs.","md",null,{},true,"\u002Fdocs\u002Freference\u002Fin-your-realm",{"title":5,"description":84},"docs\u002F5.reference\u002F1.in-your-realm",false,"VI-gk55IHpUbSKZD4cPMvvm57ynJXzUkg9dzoJV06FA",[95],{"title":16,"path":96,"stem":97,"children":98,"page":-1},"\u002Fdocs","docs",[99,103,133,160,194,265,275,297],{"title":100,"path":96,"stem":101,"stub":92,"launchGate":86,"icon":102},"Overview","docs\u002Findex","i-lucide-house",{"title":104,"stub":92,"launchGate":86,"icon":105,"path":106,"stem":107,"children":108,"page":92},"Get started","i-lucide-rocket","\u002Fdocs\u002Fget-started","docs\u002F1.get-started",[109,113,117,121,125,129],{"title":110,"path":111,"stem":112,"stub":92,"launchGate":86},"What Velrix is","\u002Fdocs\u002Fget-started\u002Fwhat-is-velrix","docs\u002F1.get-started\u002F1.what-is-velrix",{"title":114,"path":115,"stem":116,"stub":92,"launchGate":86},"Ways to run Velrix","\u002Fdocs\u002Fget-started\u002Fways-to-run","docs\u002F1.get-started\u002F2.ways-to-run",{"title":118,"path":119,"stem":120,"stub":92,"launchGate":86},"Install from USB","\u002Fdocs\u002Fget-started\u002Finstall","docs\u002F1.get-started\u002F3.install",{"title":122,"path":123,"stem":124,"stub":92,"launchGate":86},"The setup wizard","\u002Fdocs\u002Fget-started\u002Fsetup-wizard","docs\u002F1.get-started\u002F4.setup-wizard",{"title":126,"path":127,"stem":128,"stub":92,"launchGate":86},"Your first app","\u002Fdocs\u002Fget-started\u002Ffirst-app","docs\u002F1.get-started\u002F5.first-app",{"title":130,"path":131,"stem":132,"stub":92,"launchGate":86},"Your first VM","\u002Fdocs\u002Fget-started\u002Ffirst-vm","docs\u002F1.get-started\u002F6.first-vm",{"title":134,"stub":92,"launchGate":86,"icon":135,"path":136,"stem":137,"children":138,"page":92},"Concepts","i-lucide-lightbulb","\u002Fdocs\u002Fconcepts","docs\u002F2.concepts",[139,143,147,151,155],{"title":140,"path":141,"stem":142,"stub":88,"launchGate":86},"Realms","\u002Fdocs\u002Fconcepts\u002Frealms","docs\u002F2.concepts\u002F1.realms",{"title":144,"path":145,"stem":146,"stub":88,"launchGate":86},"Instances and hosts","\u002Fdocs\u002Fconcepts\u002Finstances-and-hosts","docs\u002F2.concepts\u002F2.instances-and-hosts",{"title":148,"path":149,"stem":150,"stub":88,"launchGate":86},"Modules and the mesh","\u002Fdocs\u002Fconcepts\u002Fmodules-and-the-mesh","docs\u002F2.concepts\u002F3.modules-and-the-mesh",{"title":152,"path":153,"stem":154,"stub":88,"launchGate":86},"Organisations, projects and permissions","\u002Fdocs\u002Fconcepts\u002Forgs-projects-permissions","docs\u002F2.concepts\u002F4.orgs-projects-permissions",{"title":156,"path":157,"stem":158,"stub":88,"launchGate":159},"Host pools","\u002Fdocs\u002Fconcepts\u002Fhost-pools","docs\u002F2.concepts\u002F5.host-pools","A1",{"title":161,"stub":92,"launchGate":86,"icon":162,"path":163,"stem":164,"children":165,"page":92},"Guides for users","i-lucide-book-open","\u002Fdocs\u002Fguides","docs\u002F3.guides",[166,170,174,178,182,186,190],{"title":167,"path":168,"stem":169,"stub":92,"launchGate":86},"Apps","\u002Fdocs\u002Fguides\u002Fapps","docs\u002F3.guides\u002F1.apps",{"title":171,"path":172,"stem":173,"stub":88,"launchGate":86},"Machines","\u002Fdocs\u002Fguides\u002Fmachines","docs\u002F3.guides\u002F2.machines",{"title":175,"path":176,"stem":177,"stub":88,"launchGate":86},"Volumes","\u002Fdocs\u002Fguides\u002Fvolumes","docs\u002F3.guides\u002F3.volumes",{"title":179,"path":180,"stem":181,"stub":92,"launchGate":86},"Stacks","\u002Fdocs\u002Fguides\u002Fstacks","docs\u002F3.guides\u002F4.stacks",{"title":183,"path":184,"stem":185,"stub":88,"launchGate":86},"Terminal and cloud shells","\u002Fdocs\u002Fguides\u002Fterminal","docs\u002F3.guides\u002F5.terminal",{"title":187,"path":188,"stem":189,"stub":92,"launchGate":86},"Registry","\u002Fdocs\u002Fguides\u002Fregistry","docs\u002F3.guides\u002F6.registry",{"title":191,"path":192,"stem":193,"stub":88,"launchGate":86},"Kubernetes","\u002Fdocs\u002Fguides\u002Fkubernetes","docs\u002F3.guides\u002F7.kubernetes",{"title":195,"stub":92,"launchGate":86,"icon":196,"path":197,"stem":198,"children":199,"page":92},"Guides for operators","i-lucide-server-cog","\u002Fdocs\u002Foperators","docs\u002F4.operators",[200,204,208,212,216,220,224,228,232,236,241,245,249,253,257,261],{"title":201,"path":202,"stem":203,"stub":92,"launchGate":86},"Updates and maintenance windows","\u002Fdocs\u002Foperators\u002Fupdates","docs\u002F4.operators\u002F1.updates",{"title":205,"path":206,"stem":207,"stub":92,"launchGate":86},"Migrate: moving VMs from VMware","\u002Fdocs\u002Foperators\u002Fmigrate","docs\u002F4.operators\u002F10.migrate",{"title":209,"path":210,"stem":211,"stub":92,"launchGate":86},"Hardware","\u002Fdocs\u002Foperators\u002Fhardware","docs\u002F4.operators\u002F11.hardware",{"title":213,"path":214,"stem":215,"stub":92,"launchGate":86},"Billing","\u002Fdocs\u002Foperators\u002Fbilling","docs\u002F4.operators\u002F12.billing",{"title":217,"path":218,"stem":219,"stub":92,"launchGate":86},"Policies","\u002Fdocs\u002Foperators\u002Fpolicies","docs\u002F4.operators\u002F13.policies",{"title":221,"path":222,"stem":223,"stub":92,"launchGate":86},"Running the realm","\u002Fdocs\u002Foperators\u002Frealm-ops","docs\u002F4.operators\u002F14.realm-ops",{"title":225,"path":226,"stem":227,"stub":92,"launchGate":86},"Public address and app hostnames","\u002Fdocs\u002Foperators\u002Fpublic-address","docs\u002F4.operators\u002F15.public-address",{"title":229,"path":230,"stem":231,"stub":92,"launchGate":86},"Library","\u002Fdocs\u002Foperators\u002Flibrary","docs\u002F4.operators\u002F16.library",{"title":233,"path":234,"stem":235,"stub":92,"launchGate":86},"Backups","\u002Fdocs\u002Foperators\u002Fbackups","docs\u002F4.operators\u002F2.backups",{"title":237,"path":238,"stem":239,"stub":88,"launchGate":240},"Availability and drain","\u002Fdocs\u002Foperators\u002Favailability","docs\u002F4.operators\u002F3.availability","A1, A2, A3",{"title":242,"path":243,"stem":244,"stub":88,"launchGate":86},"Federation","\u002Fdocs\u002Foperators\u002Ffederation","docs\u002F4.operators\u002F4.federation",{"title":246,"path":247,"stem":248,"stub":88,"launchGate":86},"Licensing","\u002Fdocs\u002Foperators\u002Flicensing","docs\u002F4.operators\u002F5.licensing",{"title":250,"path":251,"stem":252,"stub":88,"launchGate":86},"Branding: look and design","\u002Fdocs\u002Foperators\u002Fbranding","docs\u002F4.operators\u002F6.branding",{"title":254,"path":255,"stem":256,"stub":88,"launchGate":86},"Connectivity","\u002Fdocs\u002Foperators\u002Fconnectivity","docs\u002F4.operators\u002F7.connectivity",{"title":258,"path":259,"stem":260,"stub":88,"launchGate":86},"Logs","\u002Fdocs\u002Foperators\u002Flogs","docs\u002F4.operators\u002F8.logs",{"title":262,"path":263,"stem":264,"stub":92,"launchGate":86},"Directory sync: Entra ID and Okta","\u002Fdocs\u002Foperators\u002Fdirectory-sync","docs\u002F4.operators\u002F9.directory-sync",{"title":266,"stub":92,"launchGate":86,"icon":267,"path":268,"stem":269,"children":270,"page":92},"Reference","i-lucide-library","\u002Fdocs\u002Freference","docs\u002F5.reference",[271,272],{"title":5,"path":89,"stem":91,"stub":92,"launchGate":86},{"title":273,"path":73,"stem":274,"stub":92,"launchGate":86},"The velrix command","docs\u002F5.reference\u002F2.cli",{"title":276,"stub":92,"launchGate":86,"icon":277,"path":278,"stem":279,"children":280,"page":92},"Security and compliance","i-lucide-shield-check","\u002Fdocs\u002Fsecurity","docs\u002F6.security",[281,285,289,293],{"title":282,"path":283,"stem":284,"stub":88,"launchGate":86},"Post-quantum","\u002Fdocs\u002Fsecurity\u002Fpost-quantum","docs\u002F6.security\u002F1.post-quantum",{"title":286,"path":287,"stem":288,"stub":88,"launchGate":86},"GDPR","\u002Fdocs\u002Fsecurity\u002Fgdpr","docs\u002F6.security\u002F2.gdpr",{"title":290,"path":291,"stem":292,"stub":88,"launchGate":86},"NIS2 support","\u002Fdocs\u002Fsecurity\u002Fnis2","docs\u002F6.security\u002F3.nis2",{"title":294,"path":295,"stem":296,"stub":88,"launchGate":86},"Data residency","\u002Fdocs\u002Fsecurity\u002Fdata-residency","docs\u002F6.security\u002F4.data-residency",{"title":298,"path":299,"stem":300,"children":301,"stub":92,"launchGate":86,"icon":303},"Release notes","\u002Fdocs\u002Frelease-notes","docs\u002F7.release-notes\u002Findex",[302],{"title":298,"path":299,"stem":300,"stub":92,"launchGate":86},"i-lucide-scroll-text",[305,307],{"title":262,"path":263,"stem":264,"description":306,"children":-1},"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.",{"title":273,"path":73,"stem":274,"description":308,"children":-1},"The operator's command line on a Velrix server: identities, start and stop, releases, setup token."]