Pelican Client API
Base: /api/client/servers/{server}
Query mods installed on your own Pelican server (user token required).
GET
/mods
List Installed Mods
Returns all mods installed on the specified server. Optionally filter by provider, status, or type.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
server
|
string | No | Server UUID (path parameter) |
provider
|
string | No | Filter by provider: modrinth | curseforge | modtale | upload |
status
|
string | No | Filter by status: active | disabled |
type
|
string | No | Filter by type: mod | plugin |
Response Example
{"object":"list","data":[{"object":"installed_mod","data":{"filename":"sodium-0.6.0.jar","provider":"modrinth","mod_id":"AANobbMI","version_id":"mc1.21-0.6.0","version_number":"0.6.0","version_name":"Sodium 0.6.0 for MC 1.21","is_disabled":false,"loader":"fabric","type":"mod","installed_at":"2026-05-01T12:00:00Z"}},{"object":"installed_mod","data":{"filename":"fabric-api-0.100.0.jar","provider":"modrinth","mod_id":"P7dR8mSH","version_id":"mc1.21-0.100.0","version_number":"0.100.0","version_name":"Fabric API 0.100.0","is_disabled":false,"loader":"fabric","type":"mod","installed_at":"2026-05-01T12:00:00Z"}}],"meta":{"total":2}}
GET
/api/client/mods
List All Installed Mods
Returns all mods installed across every server the authenticated user owns or has subuser access to. No server UUID required. Supports optional query filters: `provider`, `status` (enabled/disabled), `type`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
provider
|
string | No | Filter by provider (e.g. curseforge, modrinth, modtale) |
status
|
string | No | Filter by status: enabled or disabled |
type
|
string | No | Filter by mod type (e.g. mod, resource-pack, shader) |
Response Example
{"object":"list","data":[{"object":"installed_mod","data":{"server_uuid":"abc12345","server_name":"My Survival Server","filename":"sodium-mc1.21.1-0.6.0-fabric.jar","provider":"modrinth","mod_id":"AANobbMI","version_id":"rAfhHfow","version_number":"0.6.0","version_name":"Sodium 0.6.0 for Minecraft 1.21.1","is_disabled":false,"loader":"fabric","type":"mod","installed_at":"2025-10-01T12:00:00+00:00"}}],"meta":{"total":1}}