[{"data":1,"prerenderedAt":934},["ShallowReactive",2],{"i-lucide:search":3,"i-lucide:github":8,"i-lucide:sun":11,"i-lucide:globe":13,"i-lucide:menu":15,"i-lucide:chevron-down":17,"i-lucide:map-pin":19,"docs-navigation-en":21,"docs-en-/docs/api":113,"docs-headings-en":592,"i-lucide:book-open":900,"i-lucide:download":902,"i-lucide:compass":904,"i-lucide:arrow-up-circle":906,"i-lucide:layers":908,"i-lucide:users":910,"i-lucide:plug":912,"i-lucide:circle-alert":914,"i-lucide:lock":916,"i-lucide:database":918,"i-lucide:folder-sync":920,"i-lucide:life-buoy":922,"i-lucide:shield-check":924,"i-lucide:archive-restore":926,"i-lucide:activity":928,"i-lucide:wrench":930,"i-lucide:link":932},{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":7},0,24,false,"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m21 21l-4.34-4.34\"/>\u003Ccircle cx=\"11\" cy=\"11\" r=\"8\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":9,"hidden":10},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5c.08-1.25-.27-2.48-1-3.5c.28-1.15.28-2.35 0-3.5c0 0-1 0-3 1.5c-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.4 5.4 0 0 0 4 9c0 3.5 3 5.5 6 5.5c-.39.49-.68 1.05-.85 1.65S8.93 17.38 9 18v4\"/>\u003Cpath d=\"M9 18c-4.51 2-5-2-7-2\"/>\u003C/g>",true,{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":12},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"4\"/>\u003Cpath d=\"M12 2v2m0 16v2M4.93 4.93l1.41 1.41m11.32 11.32l1.41 1.41M2 12h2m16 0h2M6.34 17.66l-1.41 1.41M19.07 4.93l-1.41 1.41\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":14},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"M12 2a14.5 14.5 0 0 0 0 20a14.5 14.5 0 0 0 0-20M2 12h20\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":16},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M4 5h16M4 12h16M4 19h16\"/>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":18},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m6 9l6 6l6-6\"/>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":20},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M20 10c0 4.993-5.539 10.193-7.399 11.799a1 1 0 0 1-1.202 0C9.539 20.193 4 14.993 4 10a8 8 0 0 1 16 0\"/>\u003Ccircle cx=\"12\" cy=\"10\" r=\"3\"/>\u003C/g>",[22,45],{"section":23,"items":24},"Getting started",[25,30,35,40],{"title":26,"path":27,"order":28,"icon":29},"Introduction","/docs",1,"lucide:book-open",{"title":31,"path":32,"order":33,"icon":34},"Installation","/docs/installation",2,"lucide:download",{"title":36,"path":37,"order":38,"icon":39},"Finding your way around the panel","/docs/panel-interface",2.5,"lucide:compass",{"title":41,"path":42,"order":43,"icon":44},"Upgrading Maran","/docs/upgrade",2.7,"lucide:arrow-up-circle",{"section":46,"items":47},"How it works",[48,53,58,63,68,73,78,83,88,93,98,103,108],{"title":49,"path":50,"order":51,"icon":52},"How it is built","/docs/architecture",3,"lucide:layers",{"title":54,"path":55,"order":56,"icon":57},"Hosting accounts","/docs/accounts",4,"lucide:users",{"title":59,"path":60,"order":61,"icon":62},"Websites and PHP","/docs/websites",5,"lucide:globe",{"title":64,"path":65,"order":66,"icon":67},"The provisioning API","/docs/api",6,"lucide:plug",{"title":69,"path":70,"order":71,"icon":72},"API error codes","/docs/api-errors",6.5,"lucide:circle-alert",{"title":74,"path":75,"order":76,"icon":77},"SSL certificates","/docs/ssl",7,"lucide:lock",{"title":79,"path":80,"order":81,"icon":82},"Databases","/docs/databases",8,"lucide:database",{"title":84,"path":85,"order":86,"icon":87},"File transfer and backups","/docs/file-transfer",9,"lucide:folder-sync",{"title":89,"path":90,"order":91,"icon":92},"Recovery and diagnostics","/docs/recovery",10,"lucide:life-buoy",{"title":94,"path":95,"order":96,"icon":97},"Panel certificate","/docs/panel-certificate",11,"lucide:shield-check",{"title":99,"path":100,"order":101,"icon":102},"Panel backup and restore","/docs/panel-backup",12,"lucide:archive-restore",{"title":104,"path":105,"order":106,"icon":107},"Dashboard and monitoring","/docs/monitoring",13,"lucide:activity",{"title":109,"path":110,"order":111,"icon":112},"Troubleshooting","/docs/troubleshooting",14,"lucide:wrench",{"doc":114,"isFallback":6},{"id":115,"title":64,"body":116,"description":583,"extension":584,"icon":67,"meta":585,"navigation":10,"order":66,"path":586,"rawbody":587,"section":46,"seo":588,"seoTitle":589,"stem":590,"__hash__":591},"docsEn/en/docs/api.md",{"type":117,"value":118,"toc":572},"minimark",[119,123,128,145,148,152,204,227,231,242,245,363,367,378,406,410,413,527,534,538,541,545,552,555,558,562],[120,121,122],"p",{},"Maran is meant for selling hosting, so the billing system that takes the money has to be able to\ndrive it. This page covers what that system can call.",[124,125,127],"h2",{"id":126},"a-login-not-a-key-yet","A login, not a key yet",[120,129,130,131,135,136,140,141,144],{},"A billing system authenticates today as a ",[132,133,134],"strong",{},"login",": it signs in at ",[137,138,139],"code",{},"POST /api/v1/auth/login"," and\nsends the access token it receives as a bearer token. The token is short-lived (15 minutes by\ndefault) and is renewed at ",[137,142,143],{},"POST /api/v1/auth/refresh",". The account lifecycle below needs an\nadministrator login, so give the integration a login of its own rather than a person's: its\nsessions can then be ended on their own, and its calls are told apart in the audit journal.",[120,146,147],{},"Scoped API keys, which would let a key provision accounts without reaching anything else, are not\nbuilt yet. Until they are, the integration's login has the administrator's full reach, and every call\nit makes is recorded in the audit journal alongside what people do.",[124,149,151],{"id":150},"the-account-lifecycle","The account lifecycle",[153,154,155,168],"table",{},[156,157,158],"thead",{},[159,160,161,165],"tr",{},[162,163,164],"th",{},"Call",[162,166,167],{},"What it does on the server",[169,170,171,180,188,196],"tbody",{},[159,172,173,177],{},[174,175,176],"td",{},"Create",[174,178,179],{},"Provisions the system user, its home and the plan's quota, then records the account",[159,181,182,185],{},[174,183,184],{},"Suspend",[174,186,187],{},"Stops the sites and logins and keeps everything else; this is a state, not a deletion",[159,189,190,193],{},[174,191,192],{},"Resize",[174,194,195],{},"Moves the quota, the worker budget and the limits to the new plan",[159,197,198,201],{},[174,199,200],{},"Terminate",[174,202,203],{},"Removes databases, logins and the jail, ends the account's processes, then removes the user. It aborts instead of leaving orphans",[120,205,206,207,210,211,214,215,218,219,222,223,226],{},"The calls are ",[137,208,209],{},"POST /api/v1/accounts",", ",[137,212,213],{},"POST /api/v1/accounts/{id}/suspend"," (and ",[137,216,217],{},"/reactivate","),\n",[137,220,221],{},"PUT /api/v1/accounts/{id}/plan"," and ",[137,224,225],{},"DELETE /api/v1/accounts/{id}",". Each is the same operation the panel's own screens perform. There is no separate path for machines:\nthe API and the interface call the same code, so they cannot disagree about what suspension means.",[124,228,230],{"id":229},"plan-features-accounts-and-views","Plan features, accounts and views",[120,232,233,234,237,238,241],{},"A plan create or update requires a ",[137,235,236],{},"features"," list: the full set the plan sells, which an update\nreplaces. An empty list sells none, and a request that leaves the list out is refused.\n",[137,239,240],{},"GET /api/v1/plans/features"," lists the available features (administrator).",[120,243,244],{},"A few endpoints serve the panel's own screens and are listed here for completeness:",[153,246,247,260],{},[156,248,249],{},[159,250,251,254,257],{},[162,252,253],{},"Endpoint",[162,255,256],{},"Who",[162,258,259],{},"Purpose",[169,261,262,275,287,300,315,334,347],{},[159,263,264,269,272],{},[174,265,266],{},[137,267,268],{},"GET /api/v1/dashboard/attention-count",[174,270,271],{},"Administrator",[174,273,274],{},"How many things need attention",[159,276,277,282,284],{},[174,278,279],{},[137,280,281],{},"GET /api/v1/servers",[174,283,271],{},[174,285,286],{},"The managed servers; one entry of kind local",[159,288,289,294,297],{},[174,290,291],{},[137,292,293],{},"GET /api/v1/me/accounts",[174,295,296],{},"Customer",[174,298,299],{},"The accounts the login owns",[159,301,302,307,309],{},[174,303,304],{},[137,305,306],{},"POST /api/v1/me/active-account",[174,308,296],{},[174,310,311,312],{},"Switch the active account, body ",[137,313,314],{},"{accountId}",[159,316,317,328,331],{},[174,318,319,210,322,210,325],{},[137,320,321],{},"GET",[137,323,324],{},"POST",[137,326,327],{},"DELETE /api/v1/me/pinned-pages",[174,329,330],{},"Signed-in",[174,332,333],{},"Read, add and remove favourite pages",[159,335,336,341,344],{},[174,337,338],{},[137,339,340],{},"/api/v1/me/sub-users",[174,342,343],{},"Account owner",[174,345,346],{},"Invite, change and remove team members",[159,348,349,358,360],{},[174,350,351,210,353,210,355],{},[137,352,324],{},[137,354,321],{},[137,356,357],{},"DELETE /api/v1/view-as",[174,359,271],{},[174,361,362],{},"Start, read and end viewing as an account",[124,364,366],{"id":365},"answers-without-a-body","Answers without a body",[120,368,369,370,373,374,377],{},"A change that has nothing to report answers ",[132,371,372],{},"204 No Content"," with no body. It used to answer 200\nwith the body ",[137,375,376],{},"true",", which added nothing to the status code. A client that parsed the body must\nstop doing so, and a client that checks for success should accept any 2xx. This covers:",[379,380,381,385,388,391,394,397,400,403],"ul",{},[382,383,384],"li",{},"identity: sign-out, password change, session revocation, invitations, sub-users, the security\npolicy and ending view-as;",[382,386,387],{},"plans and backups: delete;",[382,389,390],{},"cron: update, enable or disable, delete and the environment;",[382,392,393],{},"databases, sites and certificates: delete and remove;",[382,395,396],{},"firewall: allow, deny, ban, unban and whitelist removal;",[382,398,399],{},"FTPS and SFTP users: delete;",[382,401,402],{},"outgoing mail: save and send a test;",[382,404,405],{},"the log level.",[124,407,409],{"id":408},"renamed-response-fields","Renamed response fields",[120,411,412],{},"A field that used to say yes or no, for something that can also be unknown, now names each case:",[153,414,415,428],{},[156,416,417],{},[159,418,419,422,425],{},[162,420,421],{},"Where",[162,423,424],{},"Field",[162,426,427],{},"Values",[169,429,430,451,472,490,508],{},[159,431,432,435,440],{},[174,433,434],{},"Account disk usage",[174,436,437],{},[137,438,439],{},"backing",[174,441,442,210,445,210,448],{},[137,443,444],{},"enforced",[137,446,447],{},"notEnforced",[137,449,450],{},"unmeasured",[159,452,453,456,461],{},[174,454,455],{},"PHP versions",[174,457,458],{},[137,459,460],{},"defaultStatus",[174,462,463,210,466,210,469],{},[137,464,465],{},"default",[137,467,468],{},"notDefault",[137,470,471],{},"unknown",[159,473,474,477,482],{},[174,475,476],{},"Modules",[174,478,479],{},[137,480,481],{},"state",[174,483,484,210,487],{},[137,485,486],{},"enabled",[137,488,489],{},"locked",[159,491,492,495,500],{},[174,493,494],{},"Dashboard",[174,496,497],{},[137,498,499],{},"audience",[174,501,502,210,505],{},[137,503,504],{},"administrator",[137,506,507],{},"customer",[159,509,510,513,518],{},[174,511,512],{},"FTPS server",[174,514,515],{},[137,516,517],{},"tlsEnforcement",[174,519,520,210,522,210,524],{},[137,521,444],{},[137,523,447],{},[137,525,526],{},"notObserved",[120,528,529,530,533],{},"The health report no longer carries a top-level ",[137,531,532],{},"status","; read the agent and database entries\ninstead.",[124,535,537],{"id":536},"what-it-is-not","What it is not",[120,539,540],{},"The API is not a way to run commands on the server. It reaches the agent only through the typed\noperations the agent already accepts, the same closed set the panel uses. A caller cannot ask for a\nshell, because nothing on the other side accepts one.",[124,542,544],{"id":543},"errors-say-what-a-caller-may-know","Errors say what a caller may know",[120,546,547,548,551],{},"A resource that belongs to an account the caller does not act for answers ",[132,549,550],{},"not found",", never\nforbidden. A \"forbidden\" would confirm that the resource exists, which the caller is not entitled\nto know.",[120,553,554],{},"Creating the same database twice reports that it exists and leaves the first password working. A\nretry after a lost response must not invalidate a credential the customer has already been shown.",[120,556,557],{},"An endpoint that declares no access rule is closed to customers. An anonymous caller is refused with\n401, a signed-in customer with 403 and an empty body, and only an administrator is admitted. The same\nholds for a path that matches no endpoint: a customer gets 403 there, not 404. Every endpoint names\nits rule explicitly; this default only guards against a mistake and should not be relied on.",[124,559,561],{"id":560},"every-error-code","Every error code",[120,563,564,565,567,568,571],{},"Each refusal carries a machine-stable ",[137,566,137],{}," beside a sentence in the caller's language. The full\nlist, with the HTTP status of each code, is on ",[569,570,69],"a",{"href":70},".",{"title":573,"searchDepth":33,"depth":33,"links":574},"",[575,576,577,578,579,580,581,582],{"id":126,"depth":33,"text":127},{"id":150,"depth":33,"text":151},{"id":229,"depth":33,"text":230},{"id":365,"depth":33,"text":366},{"id":408,"depth":33,"text":409},{"id":536,"depth":33,"text":537},{"id":543,"depth":33,"text":544},{"id":560,"depth":33,"text":561},"How a billing system creates, suspends, resizes and terminates hosting accounts without a person in the loop, and how an integration authenticates today.","md",{},"/en/docs/api","---\ntitle: The provisioning API\ndescription: How a billing system creates, suspends, resizes and terminates hosting accounts without a person in the loop, and how an integration authenticates today.\nseoTitle: The provisioning API a billing system drives\nsection: How it works\norder: 6\nicon: lucide:plug\n---\n\nMaran is meant for selling hosting, so the billing system that takes the money has to be able to\ndrive it. This page covers what that system can call.\n\n## A login, not a key yet\n\nA billing system authenticates today as a **login**: it signs in at `POST /api/v1/auth/login` and\nsends the access token it receives as a bearer token. The token is short-lived (15 minutes by\ndefault) and is renewed at `POST /api/v1/auth/refresh`. The account lifecycle below needs an\nadministrator login, so give the integration a login of its own rather than a person's: its\nsessions can then be ended on their own, and its calls are told apart in the audit journal.\n\nScoped API keys, which would let a key provision accounts without reaching anything else, are not\nbuilt yet. Until they are, the integration's login has the administrator's full reach, and every call\nit makes is recorded in the audit journal alongside what people do.\n\n## The account lifecycle\n\n| Call | What it does on the server |\n|---|---|\n| Create | Provisions the system user, its home and the plan's quota, then records the account |\n| Suspend | Stops the sites and logins and keeps everything else; this is a state, not a deletion |\n| Resize | Moves the quota, the worker budget and the limits to the new plan |\n| Terminate | Removes databases, logins and the jail, ends the account's processes, then removes the user. It aborts instead of leaving orphans |\n\nThe calls are `POST /api/v1/accounts`, `POST /api/v1/accounts/{id}/suspend` (and `/reactivate`),\n`PUT /api/v1/accounts/{id}/plan` and `DELETE /api/v1/accounts/{id}`. Each is the same operation the panel's own screens perform. There is no separate path for machines:\nthe API and the interface call the same code, so they cannot disagree about what suspension means.\n\n## Plan features, accounts and views\n\nA plan create or update requires a `features` list: the full set the plan sells, which an update\nreplaces. An empty list sells none, and a request that leaves the list out is refused.\n`GET /api/v1/plans/features` lists the available features (administrator).\n\nA few endpoints serve the panel's own screens and are listed here for completeness:\n\n| Endpoint | Who | Purpose |\n|---|---|---|\n| `GET /api/v1/dashboard/attention-count` | Administrator | How many things need attention |\n| `GET /api/v1/servers` | Administrator | The managed servers; one entry of kind local |\n| `GET /api/v1/me/accounts` | Customer | The accounts the login owns |\n| `POST /api/v1/me/active-account` | Customer | Switch the active account, body `{accountId}` |\n| `GET`, `POST`, `DELETE /api/v1/me/pinned-pages` | Signed-in | Read, add and remove favourite pages |\n| `/api/v1/me/sub-users` | Account owner | Invite, change and remove team members |\n| `POST`, `GET`, `DELETE /api/v1/view-as` | Administrator | Start, read and end viewing as an account |\n\n## Answers without a body\n\nA change that has nothing to report answers **204 No Content** with no body. It used to answer 200\nwith the body `true`, which added nothing to the status code. A client that parsed the body must\nstop doing so, and a client that checks for success should accept any 2xx. This covers:\n\n- identity: sign-out, password change, session revocation, invitations, sub-users, the security\n  policy and ending view-as;\n- plans and backups: delete;\n- cron: update, enable or disable, delete and the environment;\n- databases, sites and certificates: delete and remove;\n- firewall: allow, deny, ban, unban and whitelist removal;\n- FTPS and SFTP users: delete;\n- outgoing mail: save and send a test;\n- the log level.\n\n## Renamed response fields\n\nA field that used to say yes or no, for something that can also be unknown, now names each case:\n\n| Where | Field | Values |\n|---|---|---|\n| Account disk usage | `backing` | `enforced`, `notEnforced`, `unmeasured` |\n| PHP versions | `defaultStatus` | `default`, `notDefault`, `unknown` |\n| Modules | `state` | `enabled`, `locked` |\n| Dashboard | `audience` | `administrator`, `customer` |\n| FTPS server | `tlsEnforcement` | `enforced`, `notEnforced`, `notObserved` |\n\nThe health report no longer carries a top-level `status`; read the agent and database entries\ninstead.\n\n## What it is not\n\nThe API is not a way to run commands on the server. It reaches the agent only through the typed\noperations the agent already accepts, the same closed set the panel uses. A caller cannot ask for a\nshell, because nothing on the other side accepts one.\n\n## Errors say what a caller may know\n\nA resource that belongs to an account the caller does not act for answers **not found**, never\nforbidden. A \"forbidden\" would confirm that the resource exists, which the caller is not entitled\nto know.\n\nCreating the same database twice reports that it exists and leaves the first password working. A\nretry after a lost response must not invalidate a credential the customer has already been shown.\n\nAn endpoint that declares no access rule is closed to customers. An anonymous caller is refused with\n401, a signed-in customer with 403 and an empty body, and only an administrator is admitted. The same\nholds for a path that matches no endpoint: a customer gets 403 there, not 404. Every endpoint names\nits rule explicitly; this default only guards against a mistake and should not be relied on.\n\n## Every error code\n\nEach refusal carries a machine-stable `code` beside a sentence in the caller's language. The full\nlist, with the HTTP status of each code, is on [API error codes](/docs/api-errors).\n",{"title":64,"description":583},"The provisioning API a billing system drives","en/docs/api","esOndGxrgfqMEcMAobxuVtWunEX3cFN5YsYffM6W9UA",{"/docs/accounts":593,"/docs/api":633,"/docs/api-errors":642,"/docs/architecture":655,"/docs/databases":671,"/docs/file-transfer":684,"/docs":703,"/docs/installation":716,"/docs/monitoring":732,"/docs/panel-backup":751,"/docs/panel-certificate":770,"/docs/panel-interface":789,"/docs/recovery":818,"/docs/ssl":843,"/docs/troubleshooting":852,"/docs/upgrade":865,"/docs/websites":881},[594,597,600,603,606,609,612,615,618,621,624,627,630],{"title":595,"anchor":596},"What creating one does","what-creating-one-does",{"title":598,"anchor":599},"The new account form","the-new-account-form",{"title":601,"anchor":602},"Suspension is a state, not a deletion","suspension-is-a-state-not-a-deletion",{"title":604,"anchor":605},"Deleting removes what the account left behind","deleting-removes-what-the-account-left-behind",{"title":607,"anchor":608},"Plans","plans",{"title":610,"anchor":611},"Plan features","plan-features",{"title":613,"anchor":614},"Team access: sub-users","team-access-sub-users",{"title":616,"anchor":617},"More than one account per login","more-than-one-account-per-login",{"title":619,"anchor":620},"Viewing as an account","viewing-as-an-account",{"title":622,"anchor":623},"Runtime limits","runtime-limits",{"title":625,"anchor":626},"Running a scheduled task now","running-a-scheduled-task-now",{"title":628,"anchor":629},"What a customer sees","what-a-customer-sees",{"title":631,"anchor":632},"One limitation worth knowing","one-limitation-worth-knowing",[634,635,636,637,638,639,640,641],{"title":127,"anchor":126},{"title":151,"anchor":150},{"title":230,"anchor":229},{"title":366,"anchor":365},{"title":409,"anchor":408},{"title":537,"anchor":536},{"title":544,"anchor":543},{"title":561,"anchor":560},[643,646,649,652],{"title":644,"anchor":645},"The status comes from the kind of failure","the-status-comes-from-the-kind-of-failure",{"title":647,"anchor":648},"Codes worth knowing first","codes-worth-knowing-first",{"title":650,"anchor":651},"A failed background task carries the same codes","a-failed-background-task-carries-the-same-codes",{"title":653,"anchor":654},"Every code","every-code",[656,659,662,665,668],{"title":657,"anchor":658},"The three processes","the-three-processes",{"title":660,"anchor":661},"The contract between them","the-contract-between-them",{"title":663,"anchor":664},"Writing a configuration file","writing-a-configuration-file",{"title":666,"anchor":667},"Isolation between accounts","isolation-between-accounts",{"title":669,"anchor":670},"What is deliberately absent","what-is-deliberately-absent",[672,675,678,681],{"title":673,"anchor":674},"Isolation is built, not assumed","isolation-is-built-not-assumed",{"title":676,"anchor":677},"The password is shown once","the-password-is-shown-once",{"title":679,"anchor":680},"Dropping is final","dropping-is-final",{"title":682,"anchor":683},"The grant repair, for hosts that ran an older build","the-grant-repair-for-hosts-that-ran-an-older-build",[685,688,691,694,697,700],{"title":686,"anchor":687},"Each login is jailed, and the jail is real","each-login-is-jailed-and-the-jail-is-real",{"title":689,"anchor":690},"Resetting or deleting a login ends its open sessions","resetting-or-deleting-a-login-ends-its-open-sessions",{"title":692,"anchor":693},"Public keys live outside the jail","public-keys-live-outside-the-jail",{"title":695,"anchor":696},"FTPS ships installed and switched off","ftps-ships-installed-and-switched-off",{"title":698,"anchor":699},"Backups","backups",{"title":701,"anchor":702},"What nothing re-checks","what-nothing-re-checks",[704,707,710,713],{"title":705,"anchor":706},"Three processes, and only one of them is root","three-processes-and-only-one-of-them-is-root",{"title":708,"anchor":709},"What a hosting account is","what-a-hosting-account-is",{"title":711,"anchor":712},"No brokers, no sidecars","no-brokers-no-sidecars",{"title":714,"anchor":715},"Keyboard, screen readers and motion","keyboard-screen-readers-and-motion",[717,720,723,726,729],{"title":718,"anchor":719},"Run the installer","run-the-installer",{"title":721,"anchor":722},"Installing without internet access","installing-without-internet-access",{"title":724,"anchor":725},"The first administrator","the-first-administrator",{"title":727,"anchor":728},"After the first sign-in","after-the-first-sign-in",{"title":730,"anchor":731},"Updates","updates",[733,736,739,742,745,748],{"title":734,"anchor":735},"What the dashboard shows","what-the-dashboard-shows",{"title":737,"anchor":738},"A part that could not be read says so","a-part-that-could-not-be-read-says-so",{"title":740,"anchor":741},"The disk: in use, reserved, available","the-disk-in-use-reserved-available",{"title":743,"anchor":744},"Disk use by account","disk-use-by-account",{"title":746,"anchor":747},"Alerts reach the operator by mail","alerts-reach-the-operator-by-mail",{"title":749,"anchor":750},"Panel log level","panel-log-level",[752,755,758,761,764,767],{"title":753,"anchor":754},"The passphrase file","the-passphrase-file",{"title":756,"anchor":757},"Take a backup","take-a-backup",{"title":759,"anchor":760},"What the archive contains","what-the-archive-contains",{"title":762,"anchor":763},"Restore onto a clean server","restore-onto-a-clean-server",{"title":765,"anchor":766},"Schedule it, keep a few, send a copy off the server","schedule-it-keep-a-few-send-a-copy-off-the-server",{"title":768,"anchor":769},"Limitations","limitations",[771,774,777,780,783,786],{"title":772,"anchor":773},"Order one","order-one",{"title":775,"anchor":776},"The host name comes from the server","the-host-name-comes-from-the-server",{"title":778,"anchor":779},"The port 80 challenge block","the-port-80-challenge-block",{"title":781,"anchor":782},"Renewal","renewal",{"title":784,"anchor":785},"When issuance fails","when-issuance-fails",{"title":787,"anchor":788},"Limits to know","limits-to-know",[790,793,796,799,802,805,808,809,812,815],{"title":791,"anchor":792},"The sidebar and the breadcrumb","the-sidebar-and-the-breadcrumb",{"title":794,"anchor":795},"Light, dark or system theme","light-dark-or-system-theme",{"title":797,"anchor":798},"Favourites","favourites",{"title":800,"anchor":801},"The server selector","the-server-selector",{"title":803,"anchor":804},"Switching between accounts","switching-between-accounts",{"title":806,"anchor":807},"The attention badge","the-attention-badge",{"title":619,"anchor":620},{"title":810,"anchor":811},"Lists: search, filters and pages","lists-search-filters-and-pages",{"title":813,"anchor":814},"Tables on a phone","tables-on-a-phone",{"title":816,"anchor":817},"Background tasks and their progress","background-tasks-and-their-progress",[819,822,825,828,831,834,837,840],{"title":820,"anchor":821},"Run it as root","run-it-as-root",{"title":823,"anchor":824},"Reset an administrator's password","reset-an-administrators-password",{"title":826,"anchor":827},"When correct two-factor codes are refused","when-correct-two-factor-codes-are-refused",{"title":829,"anchor":830},"Change your own password","change-your-own-password",{"title":832,"anchor":833},"Check server health","check-server-health",{"title":835,"anchor":836},"Free-space floor","free-space-floor",{"title":838,"anchor":839},"Collect a support bundle","collect-a-support-bundle",{"title":841,"anchor":842},"Read the logs, and change how much is written","read-the-logs-and-change-how-much-is-written",[844,847,848,851],{"title":845,"anchor":846},"Where the private key goes","where-the-private-key-goes",{"title":781,"anchor":782},{"title":849,"anchor":850},"What this client has not done","what-this-client-has-not-done",{"title":787,"anchor":788},[853,856,859,862],{"title":854,"anchor":855},"The panel will not start","the-panel-will-not-start",{"title":857,"anchor":858},"A site answers 502 or 404","a-site-answers-502-or-404",{"title":860,"anchor":861},"A certificate is not issued","a-certificate-is-not-issued",{"title":863,"anchor":864},"The agent is unreachable","the-agent-is-unreachable",[866,869,872,875,878],{"title":867,"anchor":868},"1. Take a panel backup first","_1-take-a-panel-backup-first",{"title":870,"anchor":871},"2. Run the installer again","_2-run-the-installer-again",{"title":873,"anchor":874},"What the installer keeps and what it changes","what-the-installer-keeps-and-what-it-changes",{"title":876,"anchor":877},"3. Check the result","_3-check-the-result",{"title":879,"anchor":880},"If the upgrade fails","if-the-upgrade-fails",[882,885,888,891,894,897],{"title":883,"anchor":884},"Configuration is validated by the server itself","configuration-is-validated-by-the-server-itself",{"title":886,"anchor":887},"Values are validated, not escaped","values-are-validated-not-escaped",{"title":889,"anchor":890},"Aliases","aliases",{"title":892,"anchor":893},"Closed sets are chosen, not typed","closed-sets-are-chosen-not-typed",{"title":895,"anchor":896},"Several PHP versions at once","several-php-versions-at-once",{"title":898,"anchor":899},"Logs","logs",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":901},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 5v16m8.001-2A2 2 0 0 0 22 17V5a2 2 0 0 0-1.999-2L16 3.002A5 5 0 0 0 12 5a5 5 0 0 0-4-2H4a2 2 0 0 0-2 2v12a2 2 0 0 0 1.999 2H8a5 5 0 0 1 4 2a5 5 0 0 1 4-2z\"/>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":903},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12 15V3m9 12v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4\"/>\u003Cpath d=\"m7 10l5 5l5-5\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":905},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"m16.24 7.76l-1.804 5.411a2 2 0 0 1-1.265 1.265L7.76 16.24l1.804-5.411a2 2 0 0 1 1.265-1.265z\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":907},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"m16 12l-4-4l-4 4m4 4V8\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":909},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12.83 2.18a2 2 0 0 0-1.66 0L2.6 6.08a1 1 0 0 0 0 1.83l8.58 3.91a2 2 0 0 0 1.66 0l8.58-3.9a1 1 0 0 0 0-1.83z\"/>\u003Cpath d=\"M2 12a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 12\"/>\u003Cpath d=\"M2 17a1 1 0 0 0 .58.91l8.6 3.91a2 2 0 0 0 1.65 0l8.58-3.9A1 1 0 0 0 22 17\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":911},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M16 21v-2a4 4 0 0 0-4-4H6a4 4 0 0 0-4 4v2M16 3.128a4 4 0 0 1 0 7.744M22 21v-2a4 4 0 0 0-3-3.87\"/>\u003Ccircle cx=\"9\" cy=\"7\" r=\"4\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":913},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 22v-5m3-9V2m2 6a1 1 0 0 1 1 1v4a4 4 0 0 1-4 4h-4a4 4 0 0 1-4-4V9a1 1 0 0 1 1-1zM9 8V2\"/>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":915},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"M12 8v4m0 4h.01\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":917},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"18\" height=\"11\" x=\"3\" y=\"11\" rx=\"2\" ry=\"2\"/>\u003Cpath d=\"M7 11V7a5 5 0 0 1 10 0v4\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":919},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cellipse cx=\"12\" cy=\"5\" rx=\"9\" ry=\"3\"/>\u003Cpath d=\"M3 5v14a9 3 0 0 0 18 0V5\"/>\u003Cpath d=\"M3 12a9 3 0 0 0 18 0\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":921},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M9 20H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h3.9a2 2 0 0 1 1.69.9l.81 1.2a2 2 0 0 0 1.67.9H20a2 2 0 0 1 2 2v.5\"/>\u003Cpath d=\"M12 10v4h4\"/>\u003Cpath d=\"m12 14l1.535-1.605a5 5 0 0 1 8 1.5M22 22v-4h-4\"/>\u003Cpath d=\"m22 18l-1.535 1.605a5 5 0 0 1-8-1.5\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":923},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"/>\u003Cpath d=\"m4.93 4.93l4.24 4.24m5.66 0l4.24-4.24m-4.24 9.9l4.24 4.24m-9.9-4.24l-4.24 4.24\"/>\u003Ccircle cx=\"12\" cy=\"12\" r=\"4\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":925},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z\"/>\u003Cpath d=\"m9 12l2 2l4-4\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":927},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"20\" height=\"5\" x=\"2\" y=\"3\" rx=\"1\"/>\u003Cpath d=\"M4 8v11a2 2 0 0 0 2 2h2M20 8v11a2 2 0 0 1-2 2h-2m-7-6l3-3l3 3m-3-3v9\"/>\u003C/g>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":929},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M22 12h-2.48a2 2 0 0 0-1.93 1.46l-2.35 8.36a.25.25 0 0 1-.48 0L9.24 2.18a.25.25 0 0 0-.48 0l-2.35 8.36A2 2 0 0 1 4.49 12H2\"/>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":931},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M14.7 6.3a1 1 0 0 0 0 1.4l1.6 1.6a1 1 0 0 0 1.4 0l3.106-3.105c.32-.322.863-.22.983.218a6 6 0 0 1-8.259 7.057l-7.91 7.91a1 1 0 0 1-2.999-3l7.91-7.91a6 6 0 0 1 7.057-8.259c.438.12.54.662.219.984z\"/>",{"left":4,"top":4,"width":5,"height":5,"rotate":4,"vFlip":6,"hFlip":6,"body":933},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71\"/>\u003Cpath d=\"M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71\"/>\u003C/g>",1793873007490]