Changes in 4e8afc7a5f
Jonathan Miller — docs: organize wiki into guides/ and reference/ folders
| 1 | - | |
| 1 | + # REST API | |
| 2 | + | |
| 3 | + MokoSuiteBackup provides a REST API via the `plg_webservices_mokobackup` plugin. | |
| 4 | + | |
| 5 | + ## Authentication | |
| 6 | + | |
| 7 | + All endpoints require a Joomla API token with Super User access: | |
| 8 | + ``` | |
| 9 | + Authorization: Bearer <joomla-api-token> | |
| 10 | + ``` | |
| 11 | + | |
| 12 | + ## Endpoints | |
| 13 | + | |
| 14 | + ### Start a Backup | |
| 15 | + ``` | |
| 16 | + POST /api/index.php/v1/mokobackup/backup | |
| 17 | + ``` | |
| 18 | + ```json | |
| 19 | + {"profile": 1, "description": "API backup"} | |
| 20 | + ``` | |
| 21 | + | |
| 22 | + ### List Backup Records | |
| 23 | + ``` | |
| 24 | + GET /api/index.php/v1/mokobackup/backups | |
| 25 | + ``` | |
| 26 | + | |
| 27 | + ### Delete a Backup | |
| 28 | + ``` | |
| 29 | + DELETE /api/index.php/v1/mokobackup/backup/:id | |
| 30 | + ``` | |
| 31 | + | |
| 32 | + ### Download a Backup | |
| 33 | + ``` | |
| 34 | + GET /api/index.php/v1/mokobackup/backup/:id/download | |
| 35 | + ``` | |
| 36 | + | |
| 37 | + ### List Profiles | |
| 38 | + ``` | |
| 39 | + GET /api/index.php/v1/mokobackup/profiles | |
| 40 | + ``` | |
| 41 | + | |
| 42 | + ## MCP Server Compatibility | |
| 43 | + | |
| 44 | + The `mcp_mokobackup` MCP server supports both Akeeba and MokoSuiteBackup backends. Set target type to `"mokobackup"` in the config: | |
| 45 | + | |
| 46 | + ```json | |
| 47 | + { | |
| 48 | + "targets": { | |
| 49 | + "mysite": { | |
| 50 | + "type": "mokobackup", | |
| 51 | + "siteUrl": "https://example.com", | |
| 52 | + "secretWord": "joomla-api-token", | |
| 53 | + "profileId": 1, | |
| 54 | + "localBackupDir": "A:/var/backups/mysite" | |
| 55 | + } | |
| 56 | + } | |
| 57 | + } | |
| 58 | + ``` | |
| 59 | + | |
| 60 | + The existing `akeeba_*` MCP tools auto-detect the target type and use the correct API endpoint. | |
| 61 | + |