Maintenance Admin API

Start a launch test

POST /api/v1/upgrade/launch-test

Launches a harmless background process the way the upgrade will be launched, to check this host can run it: the shell starts it, it finds every command it needs, the PHP command line boots, and it outlives the request. Follow it until it ends; an upgrade starts only with a test that passed less than 30 minutes ago.

Responses
200 The test and its checks so far.
401 The token is missing or wrong (Unauthenticated.), or its user may not act on this object (Unauthorized). Without the Accept: application/json header, a missing or wrong token answers with a redirect to the sign-in page instead.
403 The token's admin may not manage upgrades.
422 The PHP command line cannot run the upgrade.
Start a launch test
1 2 3
curl -X POST 'https://your-domain/api/v1/upgrade/launch-test' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Response
{
    "status": "success",
    "test": {
        "id": "3b8e1f0c7a2d4e5f6a7b8c9d0e1f2a3b",
        "state": "running",
        "created_at": "2026-11-14T10:00:00+00:00",
        "php_path": "/usr/bin/php8.3",
        "method": "setsid",
        "checks": [
            {
                "key": "launch",
                "label": "The shell started a process",
                "state": "passed",
                "detail": "Process 41231, started with setsid"
            }
        ],
        "log": null
    }
}