Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
pterodactyl
GitHub Repository: pterodactyl/panel
Path: blob/1.0-develop/routes/api-client.php
10262 views
1
<?php
2
3
use Pterodactyl\Enum\ResourceLimit;
4
use Illuminate\Support\Facades\Route;
5
use Pterodactyl\Http\Controllers\Api\Client;
6
use Pterodactyl\Http\Middleware\Activity\ServerSubject;
7
use Pterodactyl\Http\Middleware\Activity\AccountSubject;
8
use Pterodactyl\Http\Middleware\RequireTwoFactorAuthentication;
9
use Pterodactyl\Http\Middleware\Api\Client\Server\ResourceBelongsToServer;
10
use Pterodactyl\Http\Middleware\Api\Client\Server\AuthenticateServerAccess;
11
12
/*
13
|--------------------------------------------------------------------------
14
| Client Control API
15
|--------------------------------------------------------------------------
16
|
17
| Endpoint: /api/client
18
|
19
*/
20
Route::get('/', [Client\ClientController::class, 'index'])->name('api:client.index');
21
Route::get('/permissions', [Client\ClientController::class, 'permissions']);
22
23
Route::prefix('/account')->middleware(AccountSubject::class)->group(function () {
24
Route::prefix('/')->withoutMiddleware(RequireTwoFactorAuthentication::class)->group(function () {
25
Route::get('/', [Client\AccountController::class, 'index'])->name('api:client.account');
26
Route::get('/two-factor', [Client\TwoFactorController::class, 'index']);
27
Route::post('/two-factor', [Client\TwoFactorController::class, 'store']);
28
Route::post('/two-factor/disable', [Client\TwoFactorController::class, 'delete']);
29
});
30
31
Route::put('/email', [Client\AccountController::class, 'updateEmail'])->name('api:client.account.update-email');
32
Route::put('/password', [Client\AccountController::class, 'updatePassword'])->name('api:client.account.update-password');
33
34
Route::get('/activity', Client\ActivityLogController::class)->name('api:client.account.activity');
35
36
Route::get('/api-keys', [Client\ApiKeyController::class, 'index']);
37
Route::post('/api-keys', [Client\ApiKeyController::class, 'store']);
38
Route::delete('/api-keys/{identifier}', [Client\ApiKeyController::class, 'delete']);
39
40
Route::prefix('/ssh-keys')->group(function () {
41
Route::get('/', [Client\SSHKeyController::class, 'index']);
42
Route::post('/', [Client\SSHKeyController::class, 'store']);
43
Route::post('/remove', [Client\SSHKeyController::class, 'delete']);
44
});
45
});
46
47
/*
48
|--------------------------------------------------------------------------
49
| Client Control API
50
|--------------------------------------------------------------------------
51
|
52
| Endpoint: /api/client/servers/{server}
53
|
54
*/
55
Route::group([
56
'prefix' => '/servers/{server}',
57
'middleware' => [
58
ServerSubject::class,
59
AuthenticateServerAccess::class,
60
ResourceBelongsToServer::class,
61
],
62
], function () {
63
Route::get('/', [Client\Servers\ServerController::class, 'index'])->name('api:client:server.view');
64
Route::middleware([ResourceLimit::Websocket->middleware()])
65
->get('/websocket', Client\Servers\WebsocketController::class)
66
->name('api:client:server.ws');
67
Route::get('/resources', Client\Servers\ResourceUtilizationController::class)->name('api:client:server.resources');
68
Route::get('/activity', Client\Servers\ActivityLogController::class)->name('api:client:server.activity');
69
70
Route::post('/command', [Client\Servers\CommandController::class, 'index']);
71
Route::post('/power', [Client\Servers\PowerController::class, 'index']);
72
73
Route::group(['prefix' => '/databases'], function () {
74
Route::get('/', [Client\Servers\DatabaseController::class, 'index']);
75
Route::middleware([ResourceLimit::Database->middleware()])
76
->post('/', [Client\Servers\DatabaseController::class, 'store']);
77
Route::post('/{database}/rotate-password', [Client\Servers\DatabaseController::class, 'rotatePassword']);
78
Route::delete('/{database}', [Client\Servers\DatabaseController::class, 'delete']);
79
});
80
81
Route::group(['prefix' => '/files'], function () {
82
Route::get('/list', [Client\Servers\FileController::class, 'directory']);
83
Route::get('/contents', [Client\Servers\FileController::class, 'contents']);
84
Route::get('/download', [Client\Servers\FileController::class, 'download']);
85
Route::put('/rename', [Client\Servers\FileController::class, 'rename']);
86
Route::post('/copy', [Client\Servers\FileController::class, 'copy']);
87
Route::post('/write', [Client\Servers\FileController::class, 'write']);
88
Route::post('/compress', [Client\Servers\FileController::class, 'compress']);
89
Route::post('/decompress', [Client\Servers\FileController::class, 'decompress']);
90
Route::post('/delete', [Client\Servers\FileController::class, 'delete']);
91
Route::post('/create-folder', [Client\Servers\FileController::class, 'create']);
92
Route::post('/chmod', [Client\Servers\FileController::class, 'chmod']);
93
Route::middleware([ResourceLimit::FilePull->middleware()])
94
->post('/pull', [Client\Servers\FileController::class, 'pull']);
95
Route::get('/upload', Client\Servers\FileUploadController::class);
96
});
97
98
Route::group(['prefix' => '/schedules'], function () {
99
Route::get('/', [Client\Servers\ScheduleController::class, 'index']);
100
Route::middleware([ResourceLimit::Schedule->middleware()])
101
->post('/', [Client\Servers\ScheduleController::class, 'store']);
102
Route::get('/{schedule}', [Client\Servers\ScheduleController::class, 'view']);
103
Route::post('/{schedule}', [Client\Servers\ScheduleController::class, 'update']);
104
Route::post('/{schedule}/execute', [Client\Servers\ScheduleController::class, 'execute']);
105
Route::delete('/{schedule}', [Client\Servers\ScheduleController::class, 'delete']);
106
107
Route::post('/{schedule}/tasks', [Client\Servers\ScheduleTaskController::class, 'store']);
108
Route::post('/{schedule}/tasks/{task}', [Client\Servers\ScheduleTaskController::class, 'update']);
109
Route::delete('/{schedule}/tasks/{task}', [Client\Servers\ScheduleTaskController::class, 'delete']);
110
});
111
112
Route::group(['prefix' => '/network'], function () {
113
Route::get('/allocations', [Client\Servers\NetworkAllocationController::class, 'index']);
114
Route::middleware([ResourceLimit::Allocation->middleware()])
115
->post('/allocations', [Client\Servers\NetworkAllocationController::class, 'store']);
116
Route::post('/allocations/{allocation}', [Client\Servers\NetworkAllocationController::class, 'update']);
117
Route::post('/allocations/{allocation}/primary', [Client\Servers\NetworkAllocationController::class, 'setPrimary']);
118
Route::delete('/allocations/{allocation}', [Client\Servers\NetworkAllocationController::class, 'delete']);
119
});
120
121
Route::group(['prefix' => '/users'], function () {
122
Route::get('/', [Client\Servers\SubuserController::class, 'index']);
123
Route::middleware([ResourceLimit::Subuser->middleware()])
124
->post('/', [Client\Servers\SubuserController::class, 'store']);
125
Route::get('/{user}', [Client\Servers\SubuserController::class, 'view']);
126
Route::post('/{user}', [Client\Servers\SubuserController::class, 'update']);
127
Route::delete('/{user}', [Client\Servers\SubuserController::class, 'delete']);
128
});
129
130
Route::group(['prefix' => '/backups'], function () {
131
Route::get('/', [Client\Servers\BackupController::class, 'index']);
132
Route::post('/', [Client\Servers\BackupController::class, 'store']);
133
Route::get('/{backup}', [Client\Servers\BackupController::class, 'view']);
134
Route::get('/{backup}/download', [Client\Servers\BackupController::class, 'download']);
135
Route::post('/{backup}/lock', [Client\Servers\BackupController::class, 'toggleLock']);
136
Route::middleware([ResourceLimit::Backup->middleware()])
137
->post('/{backup}/restore', [Client\Servers\BackupController::class, 'restore']);
138
Route::delete('/{backup}', [Client\Servers\BackupController::class, 'delete']);
139
});
140
141
Route::group(['prefix' => '/startup'], function () {
142
Route::get('/', [Client\Servers\StartupController::class, 'index']);
143
Route::put('/variable', [Client\Servers\StartupController::class, 'update']);
144
});
145
146
Route::group(['prefix' => '/settings'], function () {
147
Route::post('/rename', [Client\Servers\SettingsController::class, 'rename']);
148
Route::post('/reinstall', [Client\Servers\SettingsController::class, 'reinstall']);
149
Route::put('/docker-image', [Client\Servers\SettingsController::class, 'dockerImage']);
150
});
151
});
152
153