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