mirror of
https://github.com/pterodactyl/panel.git
synced 2025-01-31 19:01:35 +01:00
Page:
API: Service Management
Clone
0
API: Service Management
Dane Everitt edited this page 2016-01-16 00:14:02 -05:00
Table of Contents
Service Management
GET /services
Response
{
"services": [
{
"id": 1,
"name": "Minecraft",
"description": "MC Desc.",
"file": "minecraft",
"executable": "java",
"startup": "-Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"created_at": "2015-01-12 12:12:12",
"updated_at": "2015-01-12 12:12:12"
}
]
}
GET /services/:id
Returns detailed information about a given service.
Response
{
"service": {
"id": 1,
"name": "Minecraft",
"description": "MC Desc.",
"file": "minecraft",
"executable": "java",
"startup": "-Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"created_at": "2015-01-12 12:12:12",
"updated_at": "2015-01-12 12:12:12"
},
"options": [
{
"id": 1,
"name": "Vanilla",
"description": "Vanilla",
"tag": "vanilla",
"docker_image": "quay.io/pterodactyl/minecraft",
"variables": [
{
"id": 1,
"option_id": 1,
"name": "Server Jar File",
"description": "The name of the server jarfile to run the server with.",
"env_variable": "SERVER_JARFILE",
"default_value": "server.jar",
"user_viewable": 1,
"user_editable": 1,
"required": 1,
"regex": "/^[a-zA-Z0-9_\\.-]+$/",
"created_at": "2015-01-12 12:12:12",
"updated_at": "2015-01-12 12:12:12"
},
{
"id": 2,
"option_id": 1,
"name": "Version",
"description": "The version of Minecraft Vanilla to install. Use \"latest\" to install the latest version.",
"env_variable": "VANILLA_VERSION",
"default_value": "latest",
"user_viewable": 1,
"user_editable": 1,
"required": 1,
"regex": "/^(latest|[a-zA-Z0-9_\\.-]{5,6}+)$/",
"created_at": "2016-01-04 03:48:53",
"updated_at": "2016-01-04 03:48:53"
}
]
},
{
"id": 2,
"name": "Spigot",
"description": "Spigot",
"tag": "spigot",
"docker_image": "quay.io/pterodactyl/spigot",
"variables": []
}
]
}