List the catalog
The plans, games and locations you can sell.
GET/api/application/catalog
Returns active plans, enabled games and every location. Use their IDs when you set up products in your billing system.
curl https://panel.example.com/api/application/catalog \
-H "Authorization: Bearer bpnl_..."{
"plans": [
{
"id": "01JBX2Q7Z9H6R1V8K3M5N4P2T0",
"name": "Starter",
"memory": 4096,
"disk": 20480,
"cpu": 200,
"allocationLimit": 2,
"backupLimit": 2,
"locationId": null
}
],
"eggs": [
{
"id": "clx9k2m4p0001",
"name": "Minecraft",
"slug": "minecraft",
"minMemory": 2048,
"minDisk": 10240,
"ports": 1,
"variables": [
{
"env": "MAX_PLAYERS",
"name": "Max players",
"description": "How many players can join at once.",
"default": "20",
"rules": "required|integer|between:1,500"
}
]
}
],
"locations": [
{ "id": "01JBX2R0A4B5C6D7E8F9G0H1J2", "short": "lon", "long": "London" }
]
}Plans
| Field | Type | Description |
|---|---|---|
id | string | Use as planId. |
name | string | |
memory | number | MiB. |
disk | number | MiB. |
cpu | number | Percent of one core. 0 means unlimited. |
allocationLimit | number | Ports the server can use. |
backupLimit | number | Backups the server can keep. |
locationId | string or null | The only location the plan is sold in, or null for any. |
Games
| Field | Type | Description |
|---|---|---|
id | string | Use as eggId. |
name, slug | string | |
minMemory, minDisk | number | The smallest plan this game runs on, in MiB. |
ports | number | Ports the game needs. Plans with a lower allocationLimit can't run it. |
variables | array | Settings customers can change. Pass them by env name in environment. |
Each variable has env, name, description, default and rules. Rules use pipe-separated validation such as required, integer, max:64 and between:1,500.
Locations
| Field | Type | Description |
|---|---|---|
id | string | Use as locationId. |
short | string | Short code, for example lon. |
long | string or null | Display name. |