589 lines
25 KiB
JSON
589 lines
25 KiB
JSON
[
|
|
{
|
|
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001",
|
|
"status": 200,
|
|
"body": {
|
|
"object": "server",
|
|
"attributes": {
|
|
"server_owner": true,
|
|
"identifier": "5e7f0001",
|
|
"__deprecated_uuid_short": "5e7f0001",
|
|
"server_identifier": "serv_lz7qaaiaabaabaaaaaaaaaaaae",
|
|
"internal_id": 1,
|
|
"uuid": "5e7f0001-0000-4000-8000-000000000001",
|
|
"name": "Survival",
|
|
"node": "node-alpha",
|
|
"is_node_under_maintenance": false,
|
|
"sftp_details": {
|
|
"ip": "alpha.example.test",
|
|
"port": 2022
|
|
},
|
|
"description": "Main survival world",
|
|
"limits": {
|
|
"memory": 2048,
|
|
"swap": 512,
|
|
"disk": 10240,
|
|
"io": 500,
|
|
"cpu": 200,
|
|
"threads": "0-3",
|
|
"oom_disabled": true
|
|
},
|
|
"invocation": "java -Xms128M -Xmx2048M -jar paper.jar",
|
|
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
|
"egg_features": [
|
|
"eula",
|
|
"java_version"
|
|
],
|
|
"egg_tags": [
|
|
"minecraft",
|
|
"premium"
|
|
],
|
|
"feature_limits": {
|
|
"databases": 5,
|
|
"allocations": 5,
|
|
"backups": 5
|
|
},
|
|
"status": null,
|
|
"is_suspended": false,
|
|
"is_installing": false,
|
|
"is_transferring": false,
|
|
"skip_scripts": false,
|
|
"relationships": {
|
|
"allocations": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 1,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": "play.example.test",
|
|
"port": 25565,
|
|
"notes": "Primary <game> port",
|
|
"is_default": true
|
|
}
|
|
},
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 2,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": null,
|
|
"port": 25566,
|
|
"notes": "Query/RCON",
|
|
"is_default": false
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"variables": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Server Jar File",
|
|
"description": "The name of the server jarfile to run.",
|
|
"env_variable": "SERVER_JARFILE",
|
|
"default_value": "server.jar",
|
|
"server_value": "paper.jar",
|
|
"is_editable": true,
|
|
"rules": "required|regex:/^([\\w\\d._-]+)(\\.jar)$/"
|
|
}
|
|
},
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Build Number",
|
|
"description": "The build to download, or \"latest\".",
|
|
"env_variable": "BUILD_NUMBER",
|
|
"default_value": "latest",
|
|
"server_value": null,
|
|
"is_editable": false,
|
|
"rules": "required|string|max:20"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"is_server_owner": true,
|
|
"user_permissions": [
|
|
"*"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001?include=egg",
|
|
"status": 200,
|
|
"body": {
|
|
"object": "server",
|
|
"attributes": {
|
|
"server_owner": true,
|
|
"identifier": "5e7f0001",
|
|
"__deprecated_uuid_short": "5e7f0001",
|
|
"server_identifier": "serv_lz7qaaiaabaabaaaaaaaaaaaae",
|
|
"internal_id": 1,
|
|
"uuid": "5e7f0001-0000-4000-8000-000000000001",
|
|
"name": "Survival",
|
|
"node": "node-alpha",
|
|
"is_node_under_maintenance": false,
|
|
"sftp_details": {
|
|
"ip": "alpha.example.test",
|
|
"port": 2022
|
|
},
|
|
"description": "Main survival world",
|
|
"limits": {
|
|
"memory": 2048,
|
|
"swap": 512,
|
|
"disk": 10240,
|
|
"io": 500,
|
|
"cpu": 200,
|
|
"threads": "0-3",
|
|
"oom_disabled": true
|
|
},
|
|
"invocation": "java -Xms128M -Xmx2048M -jar paper.jar",
|
|
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
|
"egg_features": [
|
|
"eula",
|
|
"java_version"
|
|
],
|
|
"egg_tags": [
|
|
"minecraft",
|
|
"premium"
|
|
],
|
|
"feature_limits": {
|
|
"databases": 5,
|
|
"allocations": 5,
|
|
"backups": 5
|
|
},
|
|
"status": null,
|
|
"is_suspended": false,
|
|
"is_installing": false,
|
|
"is_transferring": false,
|
|
"skip_scripts": false,
|
|
"relationships": {
|
|
"allocations": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 1,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": "play.example.test",
|
|
"port": 25565,
|
|
"notes": "Primary <game> port",
|
|
"is_default": true
|
|
}
|
|
},
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 2,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": null,
|
|
"port": 25566,
|
|
"notes": "Query/RCON",
|
|
"is_default": false
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"variables": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Server Jar File",
|
|
"description": "The name of the server jarfile to run.",
|
|
"env_variable": "SERVER_JARFILE",
|
|
"default_value": "server.jar",
|
|
"server_value": "paper.jar",
|
|
"is_editable": true,
|
|
"rules": "required|regex:/^([\\w\\d._-]+)(\\.jar)$/"
|
|
}
|
|
},
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Build Number",
|
|
"description": "The build to download, or \"latest\".",
|
|
"env_variable": "BUILD_NUMBER",
|
|
"default_value": "latest",
|
|
"server_value": null,
|
|
"is_editable": false,
|
|
"rules": "required|string|max:20"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"egg": {
|
|
"object": "egg",
|
|
"attributes": {
|
|
"uuid": "e9900001-0000-4000-8000-000000000001",
|
|
"name": "Paper"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"is_server_owner": true,
|
|
"user_permissions": [
|
|
"*"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001?include=subusers",
|
|
"status": 200,
|
|
"body": {
|
|
"object": "server",
|
|
"attributes": {
|
|
"server_owner": true,
|
|
"identifier": "5e7f0001",
|
|
"__deprecated_uuid_short": "5e7f0001",
|
|
"server_identifier": "serv_lz7qaaiaabaabaaaaaaaaaaaae",
|
|
"internal_id": 1,
|
|
"uuid": "5e7f0001-0000-4000-8000-000000000001",
|
|
"name": "Survival",
|
|
"node": "node-alpha",
|
|
"is_node_under_maintenance": false,
|
|
"sftp_details": {
|
|
"ip": "alpha.example.test",
|
|
"port": 2022
|
|
},
|
|
"description": "Main survival world",
|
|
"limits": {
|
|
"memory": 2048,
|
|
"swap": 512,
|
|
"disk": 10240,
|
|
"io": 500,
|
|
"cpu": 200,
|
|
"threads": "0-3",
|
|
"oom_disabled": true
|
|
},
|
|
"invocation": "java -Xms128M -Xmx2048M -jar paper.jar",
|
|
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
|
"egg_features": [
|
|
"eula",
|
|
"java_version"
|
|
],
|
|
"egg_tags": [
|
|
"minecraft",
|
|
"premium"
|
|
],
|
|
"feature_limits": {
|
|
"databases": 5,
|
|
"allocations": 5,
|
|
"backups": 5
|
|
},
|
|
"status": null,
|
|
"is_suspended": false,
|
|
"is_installing": false,
|
|
"is_transferring": false,
|
|
"skip_scripts": false,
|
|
"relationships": {
|
|
"allocations": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 1,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": "play.example.test",
|
|
"port": 25565,
|
|
"notes": "Primary <game> port",
|
|
"is_default": true
|
|
}
|
|
},
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 2,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": null,
|
|
"port": 25566,
|
|
"notes": "Query/RCON",
|
|
"is_default": false
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"variables": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Server Jar File",
|
|
"description": "The name of the server jarfile to run.",
|
|
"env_variable": "SERVER_JARFILE",
|
|
"default_value": "server.jar",
|
|
"server_value": "paper.jar",
|
|
"is_editable": true,
|
|
"rules": "required|regex:/^([\\w\\d._-]+)(\\.jar)$/"
|
|
}
|
|
},
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Build Number",
|
|
"description": "The build to download, or \"latest\".",
|
|
"env_variable": "BUILD_NUMBER",
|
|
"default_value": "latest",
|
|
"server_value": null,
|
|
"is_editable": false,
|
|
"rules": "required|string|max:20"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"subusers": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "server_subuser",
|
|
"attributes": {
|
|
"uuid": "00000000-0000-4000-8000-000000000003",
|
|
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaam",
|
|
"username": "helper",
|
|
"email": "helper@example.test",
|
|
"image": "https://gravatar.com/avatar/db133fd5a01229dc12009a42eaa2e3c3",
|
|
"2fa_enabled": false,
|
|
"created_at": "2026-01-02T03:04:05+00:00",
|
|
"permissions": [
|
|
"websocket.connect",
|
|
"control.console",
|
|
"control.start",
|
|
"allocation.read",
|
|
"startup.read",
|
|
"user.read",
|
|
"database.read",
|
|
"database.view_password",
|
|
"backup.read",
|
|
"schedule.read",
|
|
"activity.read",
|
|
"file.read"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"object": "server_subuser",
|
|
"attributes": {
|
|
"uuid": "00000000-0000-4000-8000-000000000004",
|
|
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaaq",
|
|
"username": "limited",
|
|
"email": "limited@example.test",
|
|
"image": "https://gravatar.com/avatar/6a005a5825ef8aa17b476a64d40e7aab",
|
|
"2fa_enabled": false,
|
|
"created_at": "2026-01-02T03:04:05+00:00",
|
|
"permissions": [
|
|
"websocket.connect",
|
|
"control.console",
|
|
"database.read",
|
|
"database.create",
|
|
"database.update",
|
|
"backup.read",
|
|
"schedule.read",
|
|
"activity.read",
|
|
"file.read"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"is_server_owner": true,
|
|
"user_permissions": [
|
|
"*"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001?include=egg,subusers",
|
|
"status": 200,
|
|
"body": {
|
|
"object": "server",
|
|
"attributes": {
|
|
"server_owner": true,
|
|
"identifier": "5e7f0001",
|
|
"__deprecated_uuid_short": "5e7f0001",
|
|
"server_identifier": "serv_lz7qaaiaabaabaaaaaaaaaaaae",
|
|
"internal_id": 1,
|
|
"uuid": "5e7f0001-0000-4000-8000-000000000001",
|
|
"name": "Survival",
|
|
"node": "node-alpha",
|
|
"is_node_under_maintenance": false,
|
|
"sftp_details": {
|
|
"ip": "alpha.example.test",
|
|
"port": 2022
|
|
},
|
|
"description": "Main survival world",
|
|
"limits": {
|
|
"memory": 2048,
|
|
"swap": 512,
|
|
"disk": 10240,
|
|
"io": 500,
|
|
"cpu": 200,
|
|
"threads": "0-3",
|
|
"oom_disabled": true
|
|
},
|
|
"invocation": "java -Xms128M -Xmx2048M -jar paper.jar",
|
|
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
|
"egg_features": [
|
|
"eula",
|
|
"java_version"
|
|
],
|
|
"egg_tags": [
|
|
"minecraft",
|
|
"premium"
|
|
],
|
|
"feature_limits": {
|
|
"databases": 5,
|
|
"allocations": 5,
|
|
"backups": 5
|
|
},
|
|
"status": null,
|
|
"is_suspended": false,
|
|
"is_installing": false,
|
|
"is_transferring": false,
|
|
"skip_scripts": false,
|
|
"relationships": {
|
|
"allocations": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 1,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": "play.example.test",
|
|
"port": 25565,
|
|
"notes": "Primary <game> port",
|
|
"is_default": true
|
|
}
|
|
},
|
|
{
|
|
"object": "allocation",
|
|
"attributes": {
|
|
"id": 2,
|
|
"ip": "192.0.2.10",
|
|
"ip_alias": null,
|
|
"port": 25566,
|
|
"notes": "Query/RCON",
|
|
"is_default": false
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"variables": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Server Jar File",
|
|
"description": "The name of the server jarfile to run.",
|
|
"env_variable": "SERVER_JARFILE",
|
|
"default_value": "server.jar",
|
|
"server_value": "paper.jar",
|
|
"is_editable": true,
|
|
"rules": "required|regex:/^([\\w\\d._-]+)(\\.jar)$/"
|
|
}
|
|
},
|
|
{
|
|
"object": "egg_variable",
|
|
"attributes": {
|
|
"name": "Build Number",
|
|
"description": "The build to download, or \"latest\".",
|
|
"env_variable": "BUILD_NUMBER",
|
|
"default_value": "latest",
|
|
"server_value": null,
|
|
"is_editable": false,
|
|
"rules": "required|string|max:20"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"egg": {
|
|
"object": "egg",
|
|
"attributes": {
|
|
"uuid": "e9900001-0000-4000-8000-000000000001",
|
|
"name": "Paper"
|
|
}
|
|
},
|
|
"subusers": {
|
|
"object": "list",
|
|
"data": [
|
|
{
|
|
"object": "server_subuser",
|
|
"attributes": {
|
|
"uuid": "00000000-0000-4000-8000-000000000003",
|
|
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaam",
|
|
"username": "helper",
|
|
"email": "helper@example.test",
|
|
"image": "https://gravatar.com/avatar/db133fd5a01229dc12009a42eaa2e3c3",
|
|
"2fa_enabled": false,
|
|
"created_at": "2026-01-02T03:04:05+00:00",
|
|
"permissions": [
|
|
"websocket.connect",
|
|
"control.console",
|
|
"control.start",
|
|
"allocation.read",
|
|
"startup.read",
|
|
"user.read",
|
|
"database.read",
|
|
"database.view_password",
|
|
"backup.read",
|
|
"schedule.read",
|
|
"activity.read",
|
|
"file.read"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"object": "server_subuser",
|
|
"attributes": {
|
|
"uuid": "00000000-0000-4000-8000-000000000004",
|
|
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaaq",
|
|
"username": "limited",
|
|
"email": "limited@example.test",
|
|
"image": "https://gravatar.com/avatar/6a005a5825ef8aa17b476a64d40e7aab",
|
|
"2fa_enabled": false,
|
|
"created_at": "2026-01-02T03:04:05+00:00",
|
|
"permissions": [
|
|
"websocket.connect",
|
|
"control.console",
|
|
"database.read",
|
|
"database.create",
|
|
"database.update",
|
|
"backup.read",
|
|
"schedule.read",
|
|
"activity.read",
|
|
"file.read"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"meta": {
|
|
"is_server_owner": true,
|
|
"user_permissions": [
|
|
"*"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|