Upstream pterodactyl/panel state of the touched files before 152f40cc18
This commit is contained in:
upstream committed
commit
56e5db2059
11 files changed
+34637
No files matched your search
@@ -0,0 +1,167 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Pterodactyl\Http\Resources\Api\Client;
|
||||
|
||||
use Illuminate\Http\Request;
|
||||
use Pterodactyl\Enum\Permissions;
|
||||
use Pterodactyl\Extensions\Scribe\Attributes\ResponseField;
|
||||
use Pterodactyl\Http\Resources\Api\ApiResource;
|
||||
use Pterodactyl\Http\Resources\Api\ApiResourceCollection;
|
||||
use Pterodactyl\Http\Resources\Api\Includes\IncludedResource;
|
||||
use Pterodactyl\Http\Resources\Api\NullResource;
|
||||
use Pterodactyl\Models\Allocation;
|
||||
use Pterodactyl\Models\Egg;
|
||||
use Pterodactyl\Models\EggVariable;
|
||||
use Pterodactyl\Models\Server;
|
||||
use Pterodactyl\Models\Subuser;
|
||||
use UnexpectedValueException;
|
||||
|
||||
/**
|
||||
* @extends ClientResource<Server>
|
||||
*/
|
||||
#[ResponseField('server_identifier', schema: ['type' => 'string', 'pattern' => '^serv_[a-zA-Z0-9]+$', 'example' => 'serv_1a2b3c4d'])]
|
||||
#[ResponseField('description', example: 'Survival world', nullable: true)]
|
||||
#[ResponseField('status', schema: ['type' => 'string', 'nullable' => true, 'enum' => ['installing', 'install_failed', 'reinstall_failed', 'suspended', 'restoring_backup', null], 'example' => null])]
|
||||
#[ResponseField('limits.threads', schema: ['type' => 'string', 'nullable' => true, 'example' => '1,2'])]
|
||||
#[ResponseField('feature_limits.databases', 'integer', example: 5, nullable: true)]
|
||||
#[ResponseField('feature_limits.allocations', 'integer', example: 5, nullable: true)]
|
||||
#[ResponseField('feature_limits.backups', 'integer', example: 5, nullable: true)]
|
||||
#[ResponseField('egg_features', schema: ['type' => 'array', 'nullable' => true, 'items' => ['type' => 'string'], 'example' => ['eula']])]
|
||||
#[ResponseField('egg_tags', schema: ['type' => 'array', 'items' => ['type' => 'string'], 'example' => ['minecraft']])]
|
||||
class ServerResource extends ClientResource
|
||||
{
|
||||
protected array $eagerLoads = ['egg.variables', 'egg.configFrom', 'egg.tags', 'serverVariables', 'node', 'transfer', 'subusers', 'allocation'];
|
||||
|
||||
protected array $includeRelations = [
|
||||
'allocations' => ['relation' => 'allocations', 'resource' => AllocationResource::class],
|
||||
'egg' => ['relation' => 'egg', 'resource' => EggResource::class],
|
||||
'subusers' => ['relation' => 'subusers', 'resource' => SubuserResource::class],
|
||||
];
|
||||
|
||||
protected array $defaultIncludes = ['allocations', 'variables'];
|
||||
|
||||
protected array $availableIncludes = ['egg', 'subusers'];
|
||||
|
||||
public function resourceName(): string
|
||||
{
|
||||
return Server::RESOURCE_NAME;
|
||||
}
|
||||
|
||||
public function toArray(Request $request): array
|
||||
{
|
||||
$user = $this->getUser();
|
||||
$server = $this->resource;
|
||||
|
||||
$server->loadMissing(['egg.tags', 'node', 'transfer']);
|
||||
|
||||
$egg = $server->egg ?? throw new UnexpectedValueException('The server does not have an egg relationship.');
|
||||
|
||||
return [
|
||||
'server_owner' => $user->id === $server->owner_id,
|
||||
'identifier' => config('pterodactyl.features.new_server_identifiers')
|
||||
? $server->identifier
|
||||
: $server->uuidShort,
|
||||
'__deprecated_uuid_short' => $server->uuidShort,
|
||||
'server_identifier' => $server->identifier,
|
||||
'internal_id' => $server->id,
|
||||
'uuid' => $server->uuid,
|
||||
'name' => $server->name,
|
||||
'node' => $server->node->name,
|
||||
'is_node_under_maintenance' => $server->node->isUnderMaintenance(),
|
||||
'sftp_details' => [
|
||||
'ip' => $server->node->fqdn,
|
||||
'port' => $server->node->daemonSFTP,
|
||||
],
|
||||
'description' => $server->description,
|
||||
'limits' => [
|
||||
'memory' => $server->memory,
|
||||
'swap' => $server->swap,
|
||||
'disk' => $server->disk,
|
||||
'io' => $server->io,
|
||||
'cpu' => $server->cpu,
|
||||
'threads' => $server->threads,
|
||||
'oom_disabled' => $server->oom_disabled,
|
||||
],
|
||||
'invocation' => $server->startupCommand(! $user->can(Permissions::StartupRead->value, $server)),
|
||||
'docker_image' => $server->image,
|
||||
'egg_features' => $egg->inherit_features,
|
||||
'egg_tags' => $egg->tagSlugs(),
|
||||
'feature_limits' => [
|
||||
'databases' => $server->database_limit,
|
||||
'allocations' => $server->allocation_limit,
|
||||
'backups' => $server->backup_limit,
|
||||
],
|
||||
'status' => $server->status,
|
||||
// This field is deprecated, please use "status".
|
||||
'is_suspended' => $server->isSuspended(),
|
||||
// This field is deprecated, please use "status".
|
||||
'is_installing' => ! $server->isInstalled(),
|
||||
'is_transferring' => ($server->transfer) !== null,
|
||||
'skip_scripts' => $server->skip_scripts,
|
||||
];
|
||||
}
|
||||
|
||||
protected function resolveInclude(string $include): ?IncludedResource
|
||||
{
|
||||
return match ($include) {
|
||||
'allocations' => $this->includeAllocations(),
|
||||
'variables' => $this->includeVariables(),
|
||||
'egg' => $this->includeEgg(),
|
||||
'subusers' => $this->includeSubusers(),
|
||||
default => parent::resolveInclude($include),
|
||||
};
|
||||
}
|
||||
|
||||
private function includeAllocations(): ApiResourceCollection
|
||||
{
|
||||
// While we include this permission, we do need to actually handle it slightly different here
|
||||
// for the purpose of keeping things functionally working. If the user doesn't have read permissions
|
||||
// for the allocations we'll only return the primary server allocation, and any notes associated
|
||||
// with it will be hidden.
|
||||
//
|
||||
// This allows us to avoid too much permission regression, without also hiding information that
|
||||
// is generally needed for the frontend to make sense when browsing or searching results.
|
||||
if (! $this->getUser()->can(Permissions::AllocationRead->value, $this->resource)) {
|
||||
$primary = clone ($this->resource->allocation ?? throw new UnexpectedValueException('The server does not have a primary allocation.'));
|
||||
$primary->notes = null;
|
||||
|
||||
return $this->items([$primary], AllocationResource::class, Allocation::RESOURCE_NAME);
|
||||
}
|
||||
|
||||
return $this->items($this->resource->loadMissing('allocations')->allocations, AllocationResource::class, Allocation::RESOURCE_NAME);
|
||||
}
|
||||
|
||||
private function includeVariables(): ApiResourceCollection|NullResource
|
||||
{
|
||||
if (! $this->getUser()->can(Permissions::StartupRead->value, $this->resource)) {
|
||||
return $this->null();
|
||||
}
|
||||
|
||||
return $this->items(
|
||||
$this->resource->resolvedVariables()->where('user_viewable', true)->values(),
|
||||
EggVariableResource::class,
|
||||
EggVariable::RESOURCE_NAME
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ApiResource<Egg>
|
||||
*/
|
||||
private function includeEgg(): ApiResource
|
||||
{
|
||||
$egg = $this->resource->egg ?? throw new UnexpectedValueException('The server does not have an egg relationship.');
|
||||
|
||||
return $this->item($egg, EggResource::class, Egg::RESOURCE_NAME);
|
||||
}
|
||||
|
||||
private function includeSubusers(): ApiResourceCollection|NullResource
|
||||
{
|
||||
if (! $this->getUser()->can(Permissions::UserRead->value, $this->resource)) {
|
||||
return $this->null();
|
||||
}
|
||||
|
||||
return $this->items($this->resource->subusers, SubuserResource::class, Subuser::RESOURCE_NAME);
|
||||
}
|
||||
}
|
||||
+14013
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,73 @@
|
||||
import { useCallback, useEffect, useRef } from 'react';
|
||||
import { toast } from 'sonner';
|
||||
import { useCurrentServerUuid } from '@/api/server/queries';
|
||||
import { useUploadFiles } from '@/api/server/files/queries';
|
||||
import { useFileUploadActions, useServerDirectory } from '@/state/server';
|
||||
|
||||
const UPLOADED_DISPLAY_MS = 500;
|
||||
|
||||
/** Uploads into the current directory; rejects when any file failed, after its error toast. */
|
||||
export default function useFileUploader(): (files: readonly File[]) => Promise<void> {
|
||||
const removals = useRef(new Map<string, ReturnType<typeof setTimeout>>());
|
||||
const { mutateAsync } = useUploadFiles();
|
||||
const uuid = useCurrentServerUuid()!;
|
||||
const directory = useServerDirectory();
|
||||
const { removeFileUpload, pushFileUpload, setUploadProgress } = useFileUploadActions();
|
||||
|
||||
useEffect(() => {
|
||||
const pending = removals.current;
|
||||
|
||||
return () => {
|
||||
for (const [id, timeout] of pending) {
|
||||
clearTimeout(timeout);
|
||||
removeFileUpload(id);
|
||||
}
|
||||
|
||||
pending.clear();
|
||||
};
|
||||
}, [removeFileUpload]);
|
||||
|
||||
return useCallback(
|
||||
async (files) => {
|
||||
if (files.some((file) => !file.type && (!file.size || file.size === 4096))) {
|
||||
toast.error('Folder uploads are not supported.');
|
||||
throw new Error('Folder uploads are not supported.');
|
||||
}
|
||||
|
||||
const { failed } = await mutateAsync({
|
||||
uuid,
|
||||
directory,
|
||||
files: [...files],
|
||||
callbacks: {
|
||||
onFileQueued: (id, file, abort) => {
|
||||
pushFileUpload({ id, data: { name: file.name, abort, loaded: 0, total: file.size } });
|
||||
},
|
||||
onFileProgress: (id, progress) => setUploadProgress({ id, loaded: progress.loaded }),
|
||||
onFileSettled: (id, outcome) => {
|
||||
if (outcome !== 'uploaded') {
|
||||
removeFileUpload(id);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const timeout = setTimeout(() => {
|
||||
removals.current.delete(id);
|
||||
removeFileUpload(id);
|
||||
}, UPLOADED_DISPLAY_MS);
|
||||
|
||||
removals.current.set(id, timeout);
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
if (failed.length > 0) {
|
||||
throw new Error(
|
||||
failed.length === 1
|
||||
? `Unable to upload ${failed[0].name}.`
|
||||
: `Unable to upload ${failed.length} files.`
|
||||
);
|
||||
}
|
||||
},
|
||||
[mutateAsync, uuid, directory, removeFileUpload, pushFileUpload, setUploadProgress]
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
import type { Server } from '@/api/server/types';
|
||||
import type { ServerCardModel } from './dashboard';
|
||||
import { statMetric } from './server/state';
|
||||
|
||||
export interface TestServerOptions {
|
||||
identifier?: string;
|
||||
uuid?: string;
|
||||
name?: string;
|
||||
owner?: boolean;
|
||||
permissions?: string[];
|
||||
status?: Server['attributes']['status'];
|
||||
eggFeatures?: string[];
|
||||
eggTags?: string[];
|
||||
}
|
||||
|
||||
/** A server payload for fixtures and tests. */
|
||||
export function createTestServer(options: TestServerOptions = {}): Server {
|
||||
const identifier = options.identifier ?? 'test-server';
|
||||
const owner = options.owner ?? true;
|
||||
|
||||
return {
|
||||
object: 'server',
|
||||
attributes: {
|
||||
identifier,
|
||||
uuid: options.uuid ?? '11111111-1111-4111-8111-111111111111',
|
||||
__deprecated_uuid_short: identifier,
|
||||
server_identifier: identifier,
|
||||
internal_id: 1,
|
||||
server_owner: owner,
|
||||
name: options.name ?? 'Test server',
|
||||
node: 'Test node',
|
||||
is_node_under_maintenance: false,
|
||||
sftp_details: { ip: '127.0.0.1', port: 2022 },
|
||||
description: null,
|
||||
limits: { memory: 1024, swap: 0, disk: 1024, io: 500, cpu: 100, threads: null, oom_disabled: true },
|
||||
invocation: 'run',
|
||||
docker_image: 'test/image',
|
||||
egg_features: options.eggFeatures ?? [],
|
||||
egg_tags: options.eggTags ?? [],
|
||||
feature_limits: { databases: 1, allocations: 1, backups: 1 },
|
||||
status: options.status ?? null,
|
||||
is_suspended: options.status === 'suspended',
|
||||
is_installing: options.status === 'installing',
|
||||
is_transferring: false,
|
||||
skip_scripts: false,
|
||||
},
|
||||
meta: { is_server_owner: owner, user_permissions: options.permissions ?? [] },
|
||||
};
|
||||
}
|
||||
|
||||
const noop = () => {};
|
||||
|
||||
/** A running server's card, with every permission; `options` replace its fields. */
|
||||
export function createTestServerCard(options: Partial<ServerCardModel> = {}): ServerCardModel {
|
||||
return {
|
||||
identifier: 'test-server',
|
||||
uuid: '11111111-1111-4111-8111-111111111111',
|
||||
name: 'Test server',
|
||||
description: null,
|
||||
address: '127.0.0.1:25565',
|
||||
state: {
|
||||
kind: 'ready',
|
||||
power: 'running',
|
||||
cpu: statMetric(12, 100),
|
||||
memory: statMetric(256 * 1024 * 1024, 1024 * 1024 * 1024),
|
||||
disk: statMetric(512 * 1024 * 1024, 2048 * 1024 * 1024),
|
||||
},
|
||||
permissions: { start: true, stop: true, restart: true, console: true },
|
||||
actions: { start: noop, stop: noop, restart: noop },
|
||||
sending: false,
|
||||
...options,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,653 @@
|
||||
[
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001?include=egg,subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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": false,
|
||||
"user_permissions": [
|
||||
"*",
|
||||
"admin.websocket.errors",
|
||||
"admin.websocket.install",
|
||||
"admin.websocket.transfer"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/activity?include=actor",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "356a192b7913b04c54574d18c28d46e6395428ab",
|
||||
"batch": null,
|
||||
"event": "admin:server.build",
|
||||
"is_api": false,
|
||||
"ip": "203.0.113.5",
|
||||
"description": null,
|
||||
"properties": {
|
||||
"name": "Survival"
|
||||
},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:05:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000001",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaae",
|
||||
"username": "admin",
|
||||
"email": "admin@example.test",
|
||||
"image": "https://gravatar.com/avatar/51965088c5db83c3fd307f308d25198a",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "ac3478d69a3c81fa62e60f5c3696165a4e5e6ac4",
|
||||
"batch": null,
|
||||
"event": "server:power.start",
|
||||
"is_api": false,
|
||||
"ip": "198.51.100.8",
|
||||
"description": null,
|
||||
"properties": {},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:09:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "c1dfd96eea8cc2b62785275bca38ac261256e278",
|
||||
"batch": null,
|
||||
"event": "server:file.delete",
|
||||
"is_api": false,
|
||||
"ip": "198.51.100.7",
|
||||
"description": null,
|
||||
"properties": {
|
||||
"directory": "/plugins/old/",
|
||||
"files": [
|
||||
"old.jar",
|
||||
"older.jar"
|
||||
],
|
||||
"count": 2
|
||||
},
|
||||
"has_additional_metadata": true,
|
||||
"timestamp": "2026-01-02T03:10:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000002",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaai",
|
||||
"username": "owner",
|
||||
"email": "owner@example.test",
|
||||
"image": "https://gravatar.com/avatar/f17712239715b86f1dfd9ba550b7f607",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "0ade7c2cf97f75d009975f4d720d1fa6c19f4897",
|
||||
"batch": "ba7c0009-0000-4000-8000-000000000009",
|
||||
"event": "server:backup.start",
|
||||
"is_api": false,
|
||||
"ip": "203.0.113.5",
|
||||
"description": null,
|
||||
"properties": {
|
||||
"name": "Nightly",
|
||||
"locked": true
|
||||
},
|
||||
"has_additional_metadata": true,
|
||||
"timestamp": "2026-01-02T03:13:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000001",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaae",
|
||||
"username": "admin",
|
||||
"email": "admin@example.test",
|
||||
"image": "https://gravatar.com/avatar/51965088c5db83c3fd307f308d25198a",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "b1d5781111d84f7b3fe45a0852e59758cd7a87e5",
|
||||
"batch": null,
|
||||
"event": "server:console.command",
|
||||
"is_api": false,
|
||||
"ip": "198.51.100.9",
|
||||
"description": null,
|
||||
"properties": {
|
||||
"command": "say <hi> & \"bye\""
|
||||
},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:14:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 5,
|
||||
"count": 5,
|
||||
"per_page": 25,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/databases?include=password",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "eV8y0jg6",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s1_main",
|
||||
"username": "u1_mainuser",
|
||||
"connections_from": "%",
|
||||
"max_connections": 10,
|
||||
"relationships": {
|
||||
"password": {
|
||||
"object": "database_password",
|
||||
"attributes": {
|
||||
"password": "Main-Pa$$word/1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "kEjgP8V2",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s1_logs",
|
||||
"username": "u1_logsuser",
|
||||
"connections_from": "10.0.0.%",
|
||||
"max_connections": 0,
|
||||
"relationships": {
|
||||
"password": {
|
||||
"object": "database_password",
|
||||
"attributes": {
|
||||
"password": "Logs-Pa$$word\\2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0003",
|
||||
"__deprecated_uuid_short": "5e7f0003",
|
||||
"server_identifier": "serv_lz7qaayaabaabaaaaaaaaaaaam",
|
||||
"internal_id": 3,
|
||||
"uuid": "5e7f0003-0000-4000-8000-000000000003",
|
||||
"name": "Admin Lab",
|
||||
"node": "node-beta",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "beta.example.test",
|
||||
"port": 2222
|
||||
},
|
||||
"description": "Testing ground",
|
||||
"limits": {
|
||||
"memory": 512,
|
||||
"swap": -1,
|
||||
"disk": 1024,
|
||||
"io": 10,
|
||||
"cpu": 50,
|
||||
"threads": null,
|
||||
"oom_disabled": true
|
||||
},
|
||||
"invocation": "java -jar server.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft",
|
||||
"premium"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 1,
|
||||
"allocations": 1,
|
||||
"backups": 1
|
||||
},
|
||||
"status": null,
|
||||
"is_suspended": false,
|
||||
"is_installing": false,
|
||||
"is_transferring": false,
|
||||
"skip_scripts": false,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 8,
|
||||
"ip": "198.51.100.20",
|
||||
"ip_alias": null,
|
||||
"port": 30001,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"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": null,
|
||||
"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": [
|
||||
"*",
|
||||
"admin.websocket.errors",
|
||||
"admin.websocket.install",
|
||||
"admin.websocket.transfer"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/backups",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [],
|
||||
"meta": {
|
||||
"backup_count": 0,
|
||||
"pagination": {
|
||||
"total": 0,
|
||||
"count": 0,
|
||||
"per_page": 20,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/schedules",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/users",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/network/allocations",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 8,
|
||||
"ip": "198.51.100.20",
|
||||
"ip_alias": null,
|
||||
"port": 30001,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/startup",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"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": null,
|
||||
"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": {
|
||||
"startup_command": "java -jar server.jar",
|
||||
"docker_images": {
|
||||
"Java 21": "ghcr.io/pterodactyl/yolks:java_21",
|
||||
"Java 17": "ghcr.io/pterodactyl/yolks:java_17"
|
||||
},
|
||||
"raw_startup_command": "java -jar {{SERVER_JARFILE}}"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/databases",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "exjN1nQN",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s3_lab",
|
||||
"username": "u3_labuser",
|
||||
"connections_from": "%",
|
||||
"max_connections": null
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0003-0000-4000-8000-000000000003/activity",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 0,
|
||||
"count": 0,
|
||||
"per_page": 25,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,751 @@
|
||||
[
|
||||
{
|
||||
"request": "GET /api/client?include=egg,subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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": {
|
||||
"pagination": {
|
||||
"total": 1,
|
||||
"count": 1,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001?include=egg,subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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": false,
|
||||
"user_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"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/databases?include=password",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "eV8y0jg6",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s1_main",
|
||||
"username": "u1_mainuser",
|
||||
"connections_from": "%",
|
||||
"max_connections": 10,
|
||||
"relationships": {
|
||||
"password": {
|
||||
"object": "database_password",
|
||||
"attributes": {
|
||||
"password": "Main-Pa$$word/1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "kEjgP8V2",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s1_logs",
|
||||
"username": "u1_logsuser",
|
||||
"connections_from": "10.0.0.%",
|
||||
"max_connections": 0,
|
||||
"relationships": {
|
||||
"password": {
|
||||
"object": "database_password",
|
||||
"attributes": {
|
||||
"password": "Logs-Pa$$word\\2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/activity?include=actor",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "356a192b7913b04c54574d18c28d46e6395428ab",
|
||||
"batch": null,
|
||||
"event": "admin:server.build",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"name": "Survival"
|
||||
},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:05:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000001",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaae",
|
||||
"username": "admin",
|
||||
"email": "admin@example.test",
|
||||
"image": "https://gravatar.com/avatar/51965088c5db83c3fd307f308d25198a",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "ac3478d69a3c81fa62e60f5c3696165a4e5e6ac4",
|
||||
"batch": null,
|
||||
"event": "server:power.start",
|
||||
"is_api": false,
|
||||
"ip": "198.51.100.8",
|
||||
"description": null,
|
||||
"properties": {},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:09:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "c1dfd96eea8cc2b62785275bca38ac261256e278",
|
||||
"batch": null,
|
||||
"event": "server:file.delete",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"directory": "/plugins/old/",
|
||||
"files": [
|
||||
"old.jar",
|
||||
"older.jar"
|
||||
],
|
||||
"count": 2
|
||||
},
|
||||
"has_additional_metadata": true,
|
||||
"timestamp": "2026-01-02T03:10:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000002",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaai",
|
||||
"username": "owner",
|
||||
"email": "owner@example.test",
|
||||
"image": "https://gravatar.com/avatar/f17712239715b86f1dfd9ba550b7f607",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "0ade7c2cf97f75d009975f4d720d1fa6c19f4897",
|
||||
"batch": "ba7c0009-0000-4000-8000-000000000009",
|
||||
"event": "server:backup.start",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"name": "Nightly",
|
||||
"locked": true
|
||||
},
|
||||
"has_additional_metadata": true,
|
||||
"timestamp": "2026-01-02T03:13:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000001",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaae",
|
||||
"username": "admin",
|
||||
"email": "admin@example.test",
|
||||
"image": "https://gravatar.com/avatar/51965088c5db83c3fd307f308d25198a",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "b1d5781111d84f7b3fe45a0852e59758cd7a87e5",
|
||||
"batch": null,
|
||||
"event": "server:console.command",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"command": "say <hi> & \"bye\""
|
||||
},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:14:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 5,
|
||||
"count": 5,
|
||||
"per_page": 25,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/network/allocations",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"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
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/startup",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"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": {
|
||||
"startup_command": "java -Xms128M -Xmx2048M -jar paper.jar",
|
||||
"docker_images": {
|
||||
"Java 21": "ghcr.io/pterodactyl/yolks:java_21",
|
||||
"Java 17": "ghcr.io/pterodactyl/yolks:java_17"
|
||||
},
|
||||
"raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/users",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/resources",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "stats",
|
||||
"attributes": {
|
||||
"current_state": "running",
|
||||
"is_suspended": false,
|
||||
"resources": {
|
||||
"memory_bytes": 1073741824,
|
||||
"cpu_absolute": 12.5,
|
||||
"disk_bytes": 2147483648,
|
||||
"network_rx_bytes": 1024,
|
||||
"network_tx_bytes": 2048,
|
||||
"uptime": 3600000
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,759 @@
|
||||
[
|
||||
{
|
||||
"request": "GET /api/client",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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 [hidden]",
|
||||
"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": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 1,
|
||||
"count": 1,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?include=egg,subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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 [hidden]",
|
||||
"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": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
},
|
||||
"egg": {
|
||||
"object": "egg",
|
||||
"attributes": {
|
||||
"uuid": "e9900001-0000-4000-8000-000000000001",
|
||||
"name": "Paper"
|
||||
}
|
||||
},
|
||||
"subusers": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 1,
|
||||
"count": 1,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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 [hidden]",
|
||||
"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": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
}
|
||||
}
|
||||
},
|
||||
"meta": {
|
||||
"is_server_owner": false,
|
||||
"user_permissions": [
|
||||
"websocket.connect",
|
||||
"control.console",
|
||||
"database.read",
|
||||
"database.create",
|
||||
"database.update",
|
||||
"backup.read",
|
||||
"schedule.read",
|
||||
"activity.read",
|
||||
"file.read"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001?include=egg,subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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 [hidden]",
|
||||
"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": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
},
|
||||
"egg": {
|
||||
"object": "egg",
|
||||
"attributes": {
|
||||
"uuid": "e9900001-0000-4000-8000-000000000001",
|
||||
"name": "Paper"
|
||||
}
|
||||
},
|
||||
"subusers": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
}
|
||||
}
|
||||
},
|
||||
"meta": {
|
||||
"is_server_owner": false,
|
||||
"user_permissions": [
|
||||
"websocket.connect",
|
||||
"control.console",
|
||||
"database.read",
|
||||
"database.create",
|
||||
"database.update",
|
||||
"backup.read",
|
||||
"schedule.read",
|
||||
"activity.read",
|
||||
"file.read"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/databases?include=password",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "eV8y0jg6",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s1_main",
|
||||
"username": "u1_mainuser",
|
||||
"connections_from": "%",
|
||||
"max_connections": 10,
|
||||
"relationships": {
|
||||
"password": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server_database",
|
||||
"attributes": {
|
||||
"id": "kEjgP8V2",
|
||||
"host": {
|
||||
"address": "10.0.0.5",
|
||||
"port": 3306
|
||||
},
|
||||
"name": "s1_logs",
|
||||
"username": "u1_logsuser",
|
||||
"connections_from": "10.0.0.%",
|
||||
"max_connections": 0,
|
||||
"relationships": {
|
||||
"password": {
|
||||
"object": "null_resource",
|
||||
"attributes": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/activity?include=actor",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "356a192b7913b04c54574d18c28d46e6395428ab",
|
||||
"batch": null,
|
||||
"event": "admin:server.build",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"name": "Survival"
|
||||
},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:05:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000001",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaae",
|
||||
"username": "admin",
|
||||
"email": "admin@example.test",
|
||||
"image": "https://gravatar.com/avatar/51965088c5db83c3fd307f308d25198a",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "ac3478d69a3c81fa62e60f5c3696165a4e5e6ac4",
|
||||
"batch": null,
|
||||
"event": "server:power.start",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:09:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "c1dfd96eea8cc2b62785275bca38ac261256e278",
|
||||
"batch": null,
|
||||
"event": "server:file.delete",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"directory": "/plugins/old/",
|
||||
"files": [
|
||||
"old.jar",
|
||||
"older.jar"
|
||||
],
|
||||
"count": 2
|
||||
},
|
||||
"has_additional_metadata": true,
|
||||
"timestamp": "2026-01-02T03:10:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000002",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaai",
|
||||
"username": "owner",
|
||||
"email": "owner@example.test",
|
||||
"image": "https://gravatar.com/avatar/f17712239715b86f1dfd9ba550b7f607",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "0ade7c2cf97f75d009975f4d720d1fa6c19f4897",
|
||||
"batch": "ba7c0009-0000-4000-8000-000000000009",
|
||||
"event": "server:backup.start",
|
||||
"is_api": false,
|
||||
"ip": null,
|
||||
"description": null,
|
||||
"properties": {
|
||||
"name": "Nightly",
|
||||
"locked": true
|
||||
},
|
||||
"has_additional_metadata": true,
|
||||
"timestamp": "2026-01-02T03:13:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"attributes": {
|
||||
"uuid": "00000000-0000-4000-8000-000000000001",
|
||||
"identifier": "user_aaaaaaaaabaabaaaaaaaaaaaae",
|
||||
"username": "admin",
|
||||
"email": "admin@example.test",
|
||||
"image": "https://gravatar.com/avatar/51965088c5db83c3fd307f308d25198a",
|
||||
"2fa_enabled": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "activity_log",
|
||||
"attributes": {
|
||||
"id": "b1d5781111d84f7b3fe45a0852e59758cd7a87e5",
|
||||
"batch": null,
|
||||
"event": "server:console.command",
|
||||
"is_api": false,
|
||||
"ip": "198.51.100.9",
|
||||
"description": null,
|
||||
"properties": {
|
||||
"command": "say <hi> & \"bye\""
|
||||
},
|
||||
"has_additional_metadata": false,
|
||||
"timestamp": "2026-01-02T03:14:05+00:00",
|
||||
"relationships": {
|
||||
"actor": {
|
||||
"object": "user",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 5,
|
||||
"count": 5,
|
||||
"per_page": 25,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/backups",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "backup",
|
||||
"attributes": {
|
||||
"uuid": "bacc0001-0000-4000-8000-000000000001",
|
||||
"is_successful": true,
|
||||
"is_locked": true,
|
||||
"name": "Nightly",
|
||||
"ignored_files": [
|
||||
"*.log",
|
||||
"cache/"
|
||||
],
|
||||
"checksum": "sha1:0123456789abcdef",
|
||||
"bytes": 1048576,
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"completed_at": "2026-01-02T04:04:05+00:00"
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "backup",
|
||||
"attributes": {
|
||||
"uuid": "bacc0002-0000-4000-8000-000000000002",
|
||||
"is_successful": false,
|
||||
"is_locked": false,
|
||||
"name": "Failed attempt",
|
||||
"ignored_files": [],
|
||||
"checksum": null,
|
||||
"bytes": 0,
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"completed_at": "2026-01-02T03:14:05+00:00"
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "backup",
|
||||
"attributes": {
|
||||
"uuid": "bacc0003-0000-4000-8000-000000000003",
|
||||
"is_successful": false,
|
||||
"is_locked": false,
|
||||
"name": "In progress",
|
||||
"ignored_files": [
|
||||
"world/"
|
||||
],
|
||||
"checksum": null,
|
||||
"bytes": 0,
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"completed_at": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"backup_count": 2,
|
||||
"pagination": {
|
||||
"total": 3,
|
||||
"count": 3,
|
||||
"per_page": 20,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client/servers/5e7f0001-0000-4000-8000-000000000001/schedules",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server_schedule",
|
||||
"attributes": {
|
||||
"id": 1,
|
||||
"name": "Nightly restart",
|
||||
"cron": {
|
||||
"day_of_week": "*",
|
||||
"day_of_month": "*",
|
||||
"month": "*",
|
||||
"hour": "3",
|
||||
"minute": "0"
|
||||
},
|
||||
"is_active": true,
|
||||
"is_processing": false,
|
||||
"only_when_online": true,
|
||||
"last_run_at": "2026-01-02T03:04:05+00:00",
|
||||
"next_run_at": "2026-03-05T03:00:00+00:00",
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"updated_at": "2026-03-04T05:06:07+00:00",
|
||||
"relationships": {
|
||||
"tasks": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "schedule_task",
|
||||
"attributes": {
|
||||
"id": 1,
|
||||
"sequence_id": 1,
|
||||
"action": "command",
|
||||
"payload": "say \"Restarting\" in 60s",
|
||||
"time_offset": 0,
|
||||
"is_queued": false,
|
||||
"continue_on_failure": true,
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"updated_at": "2026-02-03T04:05:06+00:00"
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "schedule_task",
|
||||
"attributes": {
|
||||
"id": 2,
|
||||
"sequence_id": 2,
|
||||
"action": "power",
|
||||
"payload": "restart",
|
||||
"time_offset": 60,
|
||||
"is_queued": true,
|
||||
"continue_on_failure": false,
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"updated_at": "2026-02-03T04:05:06+00:00"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server_schedule",
|
||||
"attributes": {
|
||||
"id": 2,
|
||||
"name": "Disabled cleanup",
|
||||
"cron": {
|
||||
"day_of_week": "1-5",
|
||||
"day_of_month": "*",
|
||||
"month": "*",
|
||||
"hour": "*",
|
||||
"minute": "*/15"
|
||||
},
|
||||
"is_active": false,
|
||||
"is_processing": false,
|
||||
"only_when_online": false,
|
||||
"last_run_at": null,
|
||||
"next_run_at": null,
|
||||
"created_at": "2026-01-02T03:04:05+00:00",
|
||||
"updated_at": "2026-02-03T04:05:06+00:00",
|
||||
"relationships": {
|
||||
"tasks": {
|
||||
"object": "list",
|
||||
"data": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,662 @@
|
||||
[
|
||||
{
|
||||
"request": "GET /api/client",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0003",
|
||||
"__deprecated_uuid_short": "5e7f0003",
|
||||
"server_identifier": "serv_lz7qaayaabaabaaaaaaaaaaaam",
|
||||
"internal_id": 3,
|
||||
"uuid": "5e7f0003-0000-4000-8000-000000000003",
|
||||
"name": "Admin Lab",
|
||||
"node": "node-beta",
|
||||
"is_node_under_maintenance": true,
|
||||
"sftp_details": {
|
||||
"ip": "beta.example.test",
|
||||
"port": 2222
|
||||
},
|
||||
"description": "Testing ground",
|
||||
"limits": {
|
||||
"memory": 512,
|
||||
"swap": -1,
|
||||
"disk": 1024,
|
||||
"io": 10,
|
||||
"cpu": 50,
|
||||
"threads": null,
|
||||
"oom_disabled": true
|
||||
},
|
||||
"invocation": "java -jar server.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft",
|
||||
"premium"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 1,
|
||||
"allocations": 1,
|
||||
"backups": 1
|
||||
},
|
||||
"status": null,
|
||||
"is_suspended": false,
|
||||
"is_installing": false,
|
||||
"is_transferring": false,
|
||||
"skip_scripts": false,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 8,
|
||||
"ip": "198.51.100.20",
|
||||
"ip_alias": null,
|
||||
"port": 30001,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"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": null,
|
||||
"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": {
|
||||
"pagination": {
|
||||
"total": 1,
|
||||
"count": 1,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?type=admin",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"identifier": "5e7f0002",
|
||||
"__deprecated_uuid_short": "5e7f0002",
|
||||
"server_identifier": "serv_lz7qaaqaabaabaaaaaaaaaaaai",
|
||||
"internal_id": 2,
|
||||
"uuid": "5e7f0002-0000-4000-8000-000000000002",
|
||||
"name": "Creative",
|
||||
"node": "node-alpha",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "alpha.example.test",
|
||||
"port": 2022
|
||||
},
|
||||
"description": "",
|
||||
"limits": {
|
||||
"memory": 1024,
|
||||
"swap": 0,
|
||||
"disk": 5120,
|
||||
"io": 500,
|
||||
"cpu": 0,
|
||||
"threads": null,
|
||||
"oom_disabled": false
|
||||
},
|
||||
"invocation": "java -jar child.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 0,
|
||||
"allocations": null,
|
||||
"backups": 0
|
||||
},
|
||||
"status": "installing",
|
||||
"is_suspended": false,
|
||||
"is_installing": true,
|
||||
"is_transferring": true,
|
||||
"skip_scripts": true,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 3,
|
||||
"ip": "192.0.2.10",
|
||||
"ip_alias": null,
|
||||
"port": 25567,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "egg_variable",
|
||||
"attributes": {
|
||||
"name": "Server Jar File",
|
||||
"description": "The jar the child egg runs.",
|
||||
"env_variable": "SERVER_JARFILE",
|
||||
"default_value": "child.jar",
|
||||
"server_value": "child.jar",
|
||||
"is_editable": true,
|
||||
"rules": "required|string"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 2,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?type=admin-all&per_page=2&include=egg",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": false,
|
||||
"identifier": "5e7f0002",
|
||||
"__deprecated_uuid_short": "5e7f0002",
|
||||
"server_identifier": "serv_lz7qaaqaabaabaaaaaaaaaaaai",
|
||||
"internal_id": 2,
|
||||
"uuid": "5e7f0002-0000-4000-8000-000000000002",
|
||||
"name": "Creative",
|
||||
"node": "node-alpha",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "alpha.example.test",
|
||||
"port": 2022
|
||||
},
|
||||
"description": "",
|
||||
"limits": {
|
||||
"memory": 1024,
|
||||
"swap": 0,
|
||||
"disk": 5120,
|
||||
"io": 500,
|
||||
"cpu": 0,
|
||||
"threads": null,
|
||||
"oom_disabled": false
|
||||
},
|
||||
"invocation": "java -jar child.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 0,
|
||||
"allocations": null,
|
||||
"backups": 0
|
||||
},
|
||||
"status": "installing",
|
||||
"is_suspended": false,
|
||||
"is_installing": true,
|
||||
"is_transferring": true,
|
||||
"skip_scripts": true,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 3,
|
||||
"ip": "192.0.2.10",
|
||||
"ip_alias": null,
|
||||
"port": 25567,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "egg_variable",
|
||||
"attributes": {
|
||||
"name": "Server Jar File",
|
||||
"description": "The jar the child egg runs.",
|
||||
"env_variable": "SERVER_JARFILE",
|
||||
"default_value": "child.jar",
|
||||
"server_value": "child.jar",
|
||||
"is_editable": true,
|
||||
"rules": "required|string"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"egg": {
|
||||
"object": "egg",
|
||||
"attributes": {
|
||||
"uuid": "e9900002-0000-4000-8000-000000000002",
|
||||
"name": "Paper Child"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 3,
|
||||
"count": 2,
|
||||
"per_page": 2,
|
||||
"current_page": 1,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"next": "https://panel.example.test/api/client?type=admin-all&per_page=2&include=egg&page=2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?type=admin-all&per_page=2&page=2",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0003",
|
||||
"__deprecated_uuid_short": "5e7f0003",
|
||||
"server_identifier": "serv_lz7qaayaabaabaaaaaaaaaaaam",
|
||||
"internal_id": 3,
|
||||
"uuid": "5e7f0003-0000-4000-8000-000000000003",
|
||||
"name": "Admin Lab",
|
||||
"node": "node-beta",
|
||||
"is_node_under_maintenance": true,
|
||||
"sftp_details": {
|
||||
"ip": "beta.example.test",
|
||||
"port": 2222
|
||||
},
|
||||
"description": "Testing ground",
|
||||
"limits": {
|
||||
"memory": 512,
|
||||
"swap": -1,
|
||||
"disk": 1024,
|
||||
"io": 10,
|
||||
"cpu": 50,
|
||||
"threads": null,
|
||||
"oom_disabled": true
|
||||
},
|
||||
"invocation": "java -jar server.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_21",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft",
|
||||
"premium"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 1,
|
||||
"allocations": 1,
|
||||
"backups": 1
|
||||
},
|
||||
"status": null,
|
||||
"is_suspended": false,
|
||||
"is_installing": false,
|
||||
"is_transferring": false,
|
||||
"skip_scripts": false,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 8,
|
||||
"ip": "198.51.100.20",
|
||||
"ip_alias": null,
|
||||
"port": 30001,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"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": null,
|
||||
"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": {
|
||||
"pagination": {
|
||||
"total": 3,
|
||||
"count": 1,
|
||||
"per_page": 2,
|
||||
"current_page": 2,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"previous": "https://panel.example.test/api/client?type=admin-all&per_page=2&page=1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,997 @@
|
||||
[
|
||||
{
|
||||
"request": "GET /api/client",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0002",
|
||||
"__deprecated_uuid_short": "5e7f0002",
|
||||
"server_identifier": "serv_lz7qaaqaabaabaaaaaaaaaaaai",
|
||||
"internal_id": 2,
|
||||
"uuid": "5e7f0002-0000-4000-8000-000000000002",
|
||||
"name": "Creative",
|
||||
"node": "node-alpha",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "alpha.example.test",
|
||||
"port": 2022
|
||||
},
|
||||
"description": "",
|
||||
"limits": {
|
||||
"memory": 1024,
|
||||
"swap": 0,
|
||||
"disk": 5120,
|
||||
"io": 500,
|
||||
"cpu": 0,
|
||||
"threads": null,
|
||||
"oom_disabled": false
|
||||
},
|
||||
"invocation": "java -jar child.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 0,
|
||||
"allocations": null,
|
||||
"backups": 0
|
||||
},
|
||||
"status": "installing",
|
||||
"is_suspended": false,
|
||||
"is_installing": true,
|
||||
"is_transferring": true,
|
||||
"skip_scripts": true,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 3,
|
||||
"ip": "192.0.2.10",
|
||||
"ip_alias": null,
|
||||
"port": 25567,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "egg_variable",
|
||||
"attributes": {
|
||||
"name": "Server Jar File",
|
||||
"description": "The jar the child egg runs.",
|
||||
"env_variable": "SERVER_JARFILE",
|
||||
"default_value": "child.jar",
|
||||
"server_value": "child.jar",
|
||||
"is_editable": true,
|
||||
"rules": "required|string"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 2,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?include=egg,subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0002",
|
||||
"__deprecated_uuid_short": "5e7f0002",
|
||||
"server_identifier": "serv_lz7qaaqaabaabaaaaaaaaaaaai",
|
||||
"internal_id": 2,
|
||||
"uuid": "5e7f0002-0000-4000-8000-000000000002",
|
||||
"name": "Creative",
|
||||
"node": "node-alpha",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "alpha.example.test",
|
||||
"port": 2022
|
||||
},
|
||||
"description": "",
|
||||
"limits": {
|
||||
"memory": 1024,
|
||||
"swap": 0,
|
||||
"disk": 5120,
|
||||
"io": 500,
|
||||
"cpu": 0,
|
||||
"threads": null,
|
||||
"oom_disabled": false
|
||||
},
|
||||
"invocation": "java -jar child.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 0,
|
||||
"allocations": null,
|
||||
"backups": 0
|
||||
},
|
||||
"status": "installing",
|
||||
"is_suspended": false,
|
||||
"is_installing": true,
|
||||
"is_transferring": true,
|
||||
"skip_scripts": true,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 3,
|
||||
"ip": "192.0.2.10",
|
||||
"ip_alias": null,
|
||||
"port": 25567,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "egg_variable",
|
||||
"attributes": {
|
||||
"name": "Server Jar File",
|
||||
"description": "The jar the child egg runs.",
|
||||
"env_variable": "SERVER_JARFILE",
|
||||
"default_value": "child.jar",
|
||||
"server_value": "child.jar",
|
||||
"is_editable": true,
|
||||
"rules": "required|string"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"egg": {
|
||||
"object": "egg",
|
||||
"attributes": {
|
||||
"uuid": "e9900002-0000-4000-8000-000000000002",
|
||||
"name": "Paper Child"
|
||||
}
|
||||
},
|
||||
"subusers": {
|
||||
"object": "list",
|
||||
"data": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 2,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?filter[name]=none",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 0,
|
||||
"count": 0,
|
||||
"per_page": 50,
|
||||
"current_page": 1,
|
||||
"total_pages": 1,
|
||||
"links": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?per_page=1",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"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": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 1,
|
||||
"per_page": 1,
|
||||
"current_page": 1,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"next": "https://panel.example.test/api/client?per_page=1&page=2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?per_page=1&page=2",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0002",
|
||||
"__deprecated_uuid_short": "5e7f0002",
|
||||
"server_identifier": "serv_lz7qaaqaabaabaaaaaaaaaaaai",
|
||||
"internal_id": 2,
|
||||
"uuid": "5e7f0002-0000-4000-8000-000000000002",
|
||||
"name": "Creative",
|
||||
"node": "node-alpha",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "alpha.example.test",
|
||||
"port": 2022
|
||||
},
|
||||
"description": "",
|
||||
"limits": {
|
||||
"memory": 1024,
|
||||
"swap": 0,
|
||||
"disk": 5120,
|
||||
"io": 500,
|
||||
"cpu": 0,
|
||||
"threads": null,
|
||||
"oom_disabled": false
|
||||
},
|
||||
"invocation": "java -jar child.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 0,
|
||||
"allocations": null,
|
||||
"backups": 0
|
||||
},
|
||||
"status": "installing",
|
||||
"is_suspended": false,
|
||||
"is_installing": true,
|
||||
"is_transferring": true,
|
||||
"skip_scripts": true,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 3,
|
||||
"ip": "192.0.2.10",
|
||||
"ip_alias": null,
|
||||
"port": 25567,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "egg_variable",
|
||||
"attributes": {
|
||||
"name": "Server Jar File",
|
||||
"description": "The jar the child egg runs.",
|
||||
"env_variable": "SERVER_JARFILE",
|
||||
"default_value": "child.jar",
|
||||
"server_value": "child.jar",
|
||||
"is_editable": true,
|
||||
"rules": "required|string"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 1,
|
||||
"per_page": 1,
|
||||
"current_page": 2,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"previous": "https://panel.example.test/api/client?per_page=1&page=1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?per_page=1&page=99",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 0,
|
||||
"per_page": 1,
|
||||
"current_page": 99,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"previous": "https://panel.example.test/api/client?per_page=1&page=98"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?per_page=1&page=1&filter[uuid]=5e7f&include=egg",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"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": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 1,
|
||||
"per_page": 1,
|
||||
"current_page": 1,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"next": "https://panel.example.test/api/client?per_page=1&filter%5Buuid%5D=5e7f&include=egg&page=2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": "GET /api/client?type=owner&per_page=1&page=2&include=subusers",
|
||||
"status": 200,
|
||||
"body": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "server",
|
||||
"attributes": {
|
||||
"server_owner": true,
|
||||
"identifier": "5e7f0002",
|
||||
"__deprecated_uuid_short": "5e7f0002",
|
||||
"server_identifier": "serv_lz7qaaqaabaabaaaaaaaaaaaai",
|
||||
"internal_id": 2,
|
||||
"uuid": "5e7f0002-0000-4000-8000-000000000002",
|
||||
"name": "Creative",
|
||||
"node": "node-alpha",
|
||||
"is_node_under_maintenance": false,
|
||||
"sftp_details": {
|
||||
"ip": "alpha.example.test",
|
||||
"port": 2022
|
||||
},
|
||||
"description": "",
|
||||
"limits": {
|
||||
"memory": 1024,
|
||||
"swap": 0,
|
||||
"disk": 5120,
|
||||
"io": 500,
|
||||
"cpu": 0,
|
||||
"threads": null,
|
||||
"oom_disabled": false
|
||||
},
|
||||
"invocation": "java -jar child.jar",
|
||||
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
|
||||
"egg_features": [
|
||||
"eula",
|
||||
"java_version"
|
||||
],
|
||||
"egg_tags": [
|
||||
"minecraft"
|
||||
],
|
||||
"feature_limits": {
|
||||
"databases": 0,
|
||||
"allocations": null,
|
||||
"backups": 0
|
||||
},
|
||||
"status": "installing",
|
||||
"is_suspended": false,
|
||||
"is_installing": true,
|
||||
"is_transferring": true,
|
||||
"skip_scripts": true,
|
||||
"relationships": {
|
||||
"allocations": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "allocation",
|
||||
"attributes": {
|
||||
"id": 3,
|
||||
"ip": "192.0.2.10",
|
||||
"ip_alias": null,
|
||||
"port": 25567,
|
||||
"notes": null,
|
||||
"is_default": true
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"variables": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "egg_variable",
|
||||
"attributes": {
|
||||
"name": "Server Jar File",
|
||||
"description": "The jar the child egg runs.",
|
||||
"env_variable": "SERVER_JARFILE",
|
||||
"default_value": "child.jar",
|
||||
"server_value": "child.jar",
|
||||
"is_editable": true,
|
||||
"rules": "required|string"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"subusers": {
|
||||
"object": "list",
|
||||
"data": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"meta": {
|
||||
"pagination": {
|
||||
"total": 2,
|
||||
"count": 1,
|
||||
"per_page": 1,
|
||||
"current_page": 2,
|
||||
"total_pages": 2,
|
||||
"links": {
|
||||
"previous": "https://panel.example.test/api/client?type=owner&per_page=1&include=subusers&page=1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,588 @@
|
||||
[
|
||||
{
|
||||
"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": [
|
||||
"*"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
Reference in new issue
Block a user