Maintenance Admin API

Follow an upgrade

GET /api/v1/upgrade/progress/{id}

The run as the upgrade page shows it: its state (starting, running, done, failed, stalled or not_started), each phase with its progress, the error with where it happened, and the end of its log. A request may fail while the code is being replaced; ask again.

Parameters
id string required path
The run's id.
Responses
200 The run and the end of its log.
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.
404 No run has this id.
500 corrupt: the run's record cannot be read.
Follow an upgrade
1 2 3
curl 'https://your-domain/api/v1/upgrade/progress/9f1c2b7a4e3d5c6b8a0f1e2d3c4b5a69' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Response
{
    "run": {
        "id": "9f1c2b7a4e3d5c6b8a0f1e2d3c4b5a69",
        "state": "running",
        "from_version": "4.2.0-p180",
        "to_version": "4.2.0-p194",
        "dry_run": false,
        "percent": 42.5,
        "current_phase": "migrate.run",
        "current_label": "Running migrations",
        "phases": [
            {
                "key": "apply.extract",
                "step": "apply",
                "label": "Extracting the package",
                "state": "done",
                "done": 1,
                "total": 1,
                "item": null,
                "sub": null,
                "notes": [],
                "ms": 5210
            }
        ],
        "error": null,
        "exit": null,
        "created_at": "2026-11-14T10:01:00+00:00",
        "elapsed": 95
    },
    "log": "Running migrations: 12 of 40"
}