Skip to content

Commit 93df79e

Browse files
committed
Correct account and server management documentation with improved examples and accurate responses
1 parent 00f0a53 commit 93df79e

4 files changed

Lines changed: 39 additions & 42 deletions

File tree

docs/api/client/account.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ curl "https://your-panel.com/api/client/account/two-factor" \
167167
```json
168168
{
169169
"data": {
170-
"image_url_data": "otpauth://totp/Pterodactyl:user%40example.com?secret=LGYOWJEGVRPPGPWATP5ZHOYC7DHAYQ6S&issuer=Pterodactyl"
170+
"image_url_data": "otpauth://totp/Pterodactyl:admin%40example.com?secret=XHL4JKY746CH46YJCHA25JWAUDBAM24I&issuer=Pterodactyl",
171+
"secret": "XHL4JKY746CH46YJCHA25JWAUDBAM24I"
171172
}
172173
}
173174
```

docs/api/client/databases.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -105,16 +105,8 @@ func main() {
105105
},
106106
"name": "s4_gamedata",
107107
"username": "u4_gKGSzC8x9M",
108-
"remote": "%",
109-
"max_connections": 0,
110-
"relationships": {
111-
"password": {
112-
"object": "database_password",
113-
"attributes": {
114-
"password": "aP$9gH#x2Kw8"
115-
}
116-
}
117-
}
108+
"connections_from": "%",
109+
"max_connections": 0
118110
}
119111
},
120112
{
@@ -127,16 +119,8 @@ func main() {
127119
},
128120
"name": "s4_website",
129121
"username": "u4_hN7jL4mP6Q",
130-
"remote": "127.0.0.1",
131-
"max_connections": 10,
132-
"relationships": {
133-
"password": {
134-
"object": "database_password",
135-
"attributes": {
136-
"password": "xR$7nM#k9Lp3"
137-
}
138-
}
139-
}
122+
"connections_from": "127.0.0.1",
123+
"max_connections": 10
140124
}
141125
}
142126
]

docs/api/client/files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ print_r($data['data']);
9999
"attributes": {
100100
"name": "server.jar",
101101
"mode": "-rw-r--r--",
102-
"mode_bits": "0644",
102+
"mode_bits": "644",
103103
"size": 47698923,
104104
"is_file": true,
105105
"is_symlink": false,
@@ -113,7 +113,7 @@ print_r($data['data']);
113113
"attributes": {
114114
"name": "logs",
115115
"mode": "drwxr-xr-x",
116-
"mode_bits": "0755",
116+
"mode_bits": "755",
117117
"size": 4096,
118118
"is_file": false,
119119
"is_symlink": false,
@@ -127,7 +127,7 @@ print_r($data['data']);
127127
"attributes": {
128128
"name": "world",
129129
"mode": "drwxr-xr-x",
130-
"mode_bits": "0755",
130+
"mode_bits": "755",
131131
"size": 4096,
132132
"is_file": false,
133133
"is_symlink": false,

docs/api/client/servers.md

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -355,16 +355,22 @@ func main() {
355355
"internal_id": 4,
356356
"uuid": "d3aac109-e5e0-4331-b03e-3454f7e136dc",
357357
"name": "Survival Server",
358-
"description": "A vanilla Minecraft survival server",
359-
"status": "running",
360-
"is_suspended": false,
361-
"is_installing": false,
362-
"is_transferring": false,
363358
"node": "Node 1",
359+
"is_node_under_maintenance": false,
364360
"sftp_details": {
365361
"ip": "node.example.com",
366362
"port": 2022
367363
},
364+
"description": "A vanilla Minecraft survival server",
365+
"limits": {
366+
"memory": 1024,
367+
"swap": 0,
368+
"disk": 5120,
369+
"io": 500,
370+
"cpu": 200,
371+
"threads": null,
372+
"oom_disabled": true
373+
},
368374
"invocation": "java -Xms128M -Xmx1024M -jar server.jar",
369375
"docker_image": "ghcr.io/pterodactyl/yolks:java_17",
370376
"egg_features": [
@@ -377,20 +383,26 @@ func main() {
377383
"allocations": 1,
378384
"backups": 10
379385
},
380-
"user_permissions": [
381-
"control.console",
382-
"control.start",
383-
"control.stop",
384-
"control.restart"
385-
],
386-
"limits": {
387-
"memory": 1024,
388-
"swap": 0,
389-
"disk": 5120,
390-
"io": 500,
391-
"cpu": 200,
392-
"threads": null
386+
"status": "running",
387+
"is_suspended": false,
388+
"is_installing": false,
389+
"is_transferring": false,
390+
"relationships": {
391+
"allocations": {
392+
"object": "list",
393+
"data": []
394+
},
395+
"variables": {
396+
"object": "list",
397+
"data": []
398+
}
393399
}
400+
},
401+
"meta": {
402+
"is_server_owner": true,
403+
"user_permissions": [
404+
"*"
405+
]
394406
}
395407
}
396408
```

0 commit comments

Comments
 (0)