Pelican Client API
Base: /api/client/servers/{server}
Query modpack status and installation progress on your own Pelican server.
Endpoints
GET
/modpack
Get Modpack Status
Returns the currently installed modpack on the specified server, including update availability.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
server
|
string | No | Server UUID (path parameter) |
Response Example
{"object":"modpack_status","data":{"installed":true,"provider":"curseforge","modpack_id":"1210677","modpack_name":"All the Mods 9","version_id":"7687225","version_name":"1.0.5","installed_at":"2026-05-01T12:00:00Z","has_update":true}}
GET
/modpack/progress
Get Installation Progress
Returns the current modpack installation progress from cache. Returns running: false when no installation is active.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
server
|
string | No | Server UUID (path parameter) |
Response Example
{"object":"modpack_progress","data":{"running":true,"overall_progress":65,"started_at":"2026-05-14T16:00:00Z","steps":[{"key":"backup","status":"completed","message":"Backup created","progress":100},{"key":"download","status":"running","message":"Downloading modpack files...","progress":65},{"key":"install","status":"pending","message":"Waiting...","progress":0}]}}
GET
/api/client/modpacks
List All Modpack Statuses
Returns the modpack installation status for every server the authenticated user owns or has subuser access to. Servers without an installed modpack are included with `installed: false`.
Response Example
{"object":"list","data":[{"object":"modpack_status","data":{"server_uuid":"abc12345","server_name":"My Modded Server","installed":true,"provider":"ftb","modpack_id":"all-the-mods-9","modpack_name":"All the Mods 9","version_id":"2.33","version_name":"2.33","installed_at":"2025-10-01T12:00:00+00:00","has_update":false}},{"object":"modpack_status","data":{"server_uuid":"def67890","server_name":"Vanilla Server","installed":false}}],"meta":{"total":2}}
GET
/api/client/modpacks/progress
List Running Modpack Installations
Returns all currently running modpack installations across the user's servers. Only servers with an active installation job appear in the response.
Response Example
{"object":"list","data":[{"object":"modpack_progress","data":{"server_uuid":"abc12345","server_name":"My Modded Server","running":true,"step":"Downloading modpack files","percent":42}}],"meta":{"total":1}}