@getquick/site 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/LICENSE +21 -0
- package/README.md +14 -2
- package/bin/gq.mjs +14 -0
- package/docs/research/ploi-api.md +2371 -0
- package/package.json +56 -4
- package/src/exec.mjs +20 -0
- package/src/index.mjs +1 -0
- package/src/ops/cli.mjs +349 -0
- package/src/ops/env.mjs +73 -0
- package/src/ops/output.mjs +62 -0
- package/src/ops/ploi-api-command.mjs +225 -0
- package/src/ops/project-context.mjs +103 -0
- package/src/ops/providers/cloudflare.mjs +95 -0
- package/src/ops/providers/github.mjs +104 -0
- package/src/ops/providers/http.mjs +31 -0
- package/src/ops/providers/ploi-catalog.mjs +49 -0
- package/src/ops/providers/ploi-endpoints.mjs +1590 -0
- package/src/ops/providers/ploi.mjs +159 -0
- package/src/ops/ui.mjs +84 -0
- package/src/run.mjs +42 -0
- package/src/version.mjs +3 -0
|
@@ -0,0 +1,1590 @@
|
|
|
1
|
+
import { createPloiCatalog } from "./ploi-catalog.mjs";
|
|
2
|
+
|
|
3
|
+
export const PLOI_ENDPOINTS = [
|
|
4
|
+
{
|
|
5
|
+
id: "aliases.create-alias",
|
|
6
|
+
method: "POST",
|
|
7
|
+
path: "/api/servers/{server}/sites/{site}/aliases",
|
|
8
|
+
sourceUrl: "https://developers.ploi.io/aliases/create-alias",
|
|
9
|
+
summary: "Adds one or more aliases to your site.",
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
id: "aliases.delete-alias",
|
|
13
|
+
method: "DELETE",
|
|
14
|
+
path: "/api/servers/{server}/sites/{site}/aliases/{alias}",
|
|
15
|
+
sourceUrl: "https://developers.ploi.io/aliases/delete-alias",
|
|
16
|
+
summary: "Delete an alias from a site.",
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
id: "aliases.list-aliases",
|
|
20
|
+
method: "GET",
|
|
21
|
+
path: "/api/servers/{server}/sites/{site}/aliases",
|
|
22
|
+
sourceUrl: "https://developers.ploi.io/aliases/list-aliases",
|
|
23
|
+
summary: "List all the aliases for a site.",
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
id: "apps.install-nextcloud",
|
|
27
|
+
method: "POST",
|
|
28
|
+
path: "/api/servers/{server}/sites/{site}/nextcloud",
|
|
29
|
+
sourceUrl: "https://developers.ploi.io/apps/install-nextcloud",
|
|
30
|
+
summary: "Install Nextcloud system on this domain.",
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
id: "apps.install-statamic",
|
|
34
|
+
method: "POST",
|
|
35
|
+
path: "/api/servers/{server}/sites/{site}/statamic",
|
|
36
|
+
sourceUrl: "https://developers.ploi.io/apps/install-statamic",
|
|
37
|
+
summary: "This endpoint allows you to install Statamic to your website.",
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
id: "apps.install-wordpress",
|
|
41
|
+
method: "POST",
|
|
42
|
+
path: "/api/servers/{server}/sites/{site}/wordpress",
|
|
43
|
+
sourceUrl: "https://developers.ploi.io/apps/install-wordpress",
|
|
44
|
+
summary: "Install WordPress system on this domain.",
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
id: "apps.uninstall-nextcloud",
|
|
48
|
+
method: "DELETE",
|
|
49
|
+
path: "/api/servers/{server}/sites/{site}/nextcloud",
|
|
50
|
+
sourceUrl: "https://developers.ploi.io/apps/uninstall-nextcloud",
|
|
51
|
+
summary: "Uninstall Nextcloud system on this domain.",
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
id: "apps.uninstall-statamic",
|
|
55
|
+
method: "DELETE",
|
|
56
|
+
path: "/api/servers/{server}/sites/{site}/statamic",
|
|
57
|
+
sourceUrl: "https://developers.ploi.io/apps/uninstall-statamic",
|
|
58
|
+
summary: "Uninstall Statamic on your domain.",
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
id: "apps.uninstall-wordpress",
|
|
62
|
+
method: "DELETE",
|
|
63
|
+
path: "/api/servers/{server}/sites/{site}/wordpress",
|
|
64
|
+
sourceUrl: "https://developers.ploi.io/apps/uninstall-wordpress",
|
|
65
|
+
summary: "Uninstall WordPress system on this domain.",
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
id: "auth-users.create-auth-user",
|
|
69
|
+
method: "POST",
|
|
70
|
+
path: "/api/servers/{server}/sites/{site}/auth-users",
|
|
71
|
+
sourceUrl: "https://developers.ploi.io/auth-users/create-auth-user",
|
|
72
|
+
summary:
|
|
73
|
+
"Create a new basic authentication user for a site to protect specific paths or entire directories.",
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
id: "auth-users.delete-auth-user",
|
|
77
|
+
method: "DELETE",
|
|
78
|
+
path: "/api/servers/{server}/sites/{site}/auth-users/{authUserId}",
|
|
79
|
+
sourceUrl: "https://developers.ploi.io/auth-users/delete-auth-user",
|
|
80
|
+
summary: "Remove a basic authentication user from a site.",
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
id: "auth-users.get-auth-user",
|
|
84
|
+
method: "GET",
|
|
85
|
+
path: "/api/servers/{server}/sites/{site}/auth-users/{authUserId}",
|
|
86
|
+
sourceUrl: "https://developers.ploi.io/auth-users/get-auth-user",
|
|
87
|
+
summary: "Retrieve details of a specific authentication user for a site.",
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
id: "auth-users.list-auth-users",
|
|
91
|
+
method: "GET",
|
|
92
|
+
path: "/api/servers/{server}/sites/{site}/auth-users",
|
|
93
|
+
sourceUrl: "https://developers.ploi.io/auth-users/list-auth-users",
|
|
94
|
+
summary: "Retrieve a list of all authentication users for a specific site.",
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
id: "certificates.activate-certificate",
|
|
98
|
+
method: "POST",
|
|
99
|
+
path: "/api/servers/{server}/sites/{site}/certificates/{certificate}/activate",
|
|
100
|
+
sourceUrl: "https://developers.ploi.io/certificates/activate-certificate",
|
|
101
|
+
summary:
|
|
102
|
+
"Activate an installed SSL certificate, so the webserver serves the site with this certificate.",
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
id: "certificates.create-certificate",
|
|
106
|
+
method: "POST",
|
|
107
|
+
path: "/api/servers/{server}/sites/{site}/certificates",
|
|
108
|
+
sourceUrl: "https://developers.ploi.io/certificates/create-certificate",
|
|
109
|
+
summary: "Create an SSL certificate for your site.",
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
id: "certificates.delete-certificate",
|
|
113
|
+
method: "DELETE",
|
|
114
|
+
path: "/api/servers/{server}/sites/{site}/certificates/{certificate}",
|
|
115
|
+
sourceUrl: "https://developers.ploi.io/certificates/delete-certificate",
|
|
116
|
+
summary: "Delete an SSL certificate from your site.",
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
id: "certificates.download-certificate",
|
|
120
|
+
method: "GET",
|
|
121
|
+
path: "/api/servers/{server}/sites/{site}/certificates/{certificate}/download",
|
|
122
|
+
sourceUrl: "https://developers.ploi.io/certificates/download-certificate",
|
|
123
|
+
summary:
|
|
124
|
+
"Retrieve the certificate chain of an installed SSL certificate, so you can install it on other (internal) systems.",
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
id: "certificates.get-certificate",
|
|
128
|
+
method: "GET",
|
|
129
|
+
path: "/api/servers/{server}/sites/{site}/certificates/{certificate}",
|
|
130
|
+
sourceUrl: "https://developers.ploi.io/certificates/get-certificate",
|
|
131
|
+
summary: "Get a specific SSL certificate.",
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
id: "certificates.list-certificates",
|
|
135
|
+
method: "GET",
|
|
136
|
+
path: "/api/servers/{server}/sites/{site}/certificates",
|
|
137
|
+
sourceUrl: "https://developers.ploi.io/certificates/list-certificates",
|
|
138
|
+
summary: "List all SSL certificates for a site.",
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
id: "containers.container-logs",
|
|
142
|
+
method: "GET",
|
|
143
|
+
path: "/api/servers/{server}/docker/containers/{container}/logs",
|
|
144
|
+
sourceUrl: "https://developers.ploi.io/containers/container-logs",
|
|
145
|
+
summary: "Retrieve logs from a Docker container on your server.",
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
id: "containers.create-container",
|
|
149
|
+
method: "POST",
|
|
150
|
+
path: "/api/servers/{server}/docker/containers",
|
|
151
|
+
sourceUrl: "https://developers.ploi.io/containers/create-container",
|
|
152
|
+
summary: "Creates a new docker application container in your server.",
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
id: "containers.delete-container",
|
|
156
|
+
method: "DELETE",
|
|
157
|
+
path: "/api/servers/{server}/docker/containers/{container}",
|
|
158
|
+
sourceUrl: "https://developers.ploi.io/containers/delete-container",
|
|
159
|
+
summary: "Deletes a container from your server.",
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
id: "containers.get-container",
|
|
163
|
+
method: "GET",
|
|
164
|
+
path: "/api/servers/{server}/docker/containers/{container}",
|
|
165
|
+
sourceUrl: "https://developers.ploi.io/containers/get-container",
|
|
166
|
+
summary: "Get a specific container from your server.",
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
id: "containers.link-site",
|
|
170
|
+
method: "POST",
|
|
171
|
+
path: "/api/servers/{server}/docker/containers/{container}/site/link",
|
|
172
|
+
sourceUrl: "https://developers.ploi.io/containers/link-site",
|
|
173
|
+
summary: "Link a site to a Docker container to proxy requests to the container.",
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
id: "containers.list-containers",
|
|
177
|
+
method: "GET",
|
|
178
|
+
path: "/api/servers/{server}/docker/containers",
|
|
179
|
+
sourceUrl: "https://developers.ploi.io/containers/list-containers",
|
|
180
|
+
summary: "List all the docker containers on your server.",
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
id: "containers.start-container",
|
|
184
|
+
method: "POST",
|
|
185
|
+
path: "/api/servers/{server}/docker/containers/{container}/up",
|
|
186
|
+
sourceUrl: "https://developers.ploi.io/containers/start-container",
|
|
187
|
+
summary: "Start a container in your server.",
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
id: "containers.stop-container",
|
|
191
|
+
method: "POST",
|
|
192
|
+
path: "/api/servers/{server}/docker/containers/{container}/down",
|
|
193
|
+
sourceUrl: "https://developers.ploi.io/containers/stop-container",
|
|
194
|
+
summary: "Stop a container in your server.",
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
id: "containers.unlink-site",
|
|
198
|
+
method: "DELETE",
|
|
199
|
+
path: "/api/servers/{server}/docker/containers/{container}/site/unlink",
|
|
200
|
+
sourceUrl: "https://developers.ploi.io/containers/unlink-site",
|
|
201
|
+
summary: "Unlink a site from a Docker container.",
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
id: "containers.update-container",
|
|
205
|
+
method: "PATCH",
|
|
206
|
+
path: "/api/servers/{server}/docker/containers/{container}",
|
|
207
|
+
sourceUrl: "https://developers.ploi.io/containers/update-container",
|
|
208
|
+
summary: "Update a specific container in your server.",
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
id: "crontabs.create-crontab",
|
|
212
|
+
method: "POST",
|
|
213
|
+
path: "/api/servers/{server}/crontabs",
|
|
214
|
+
sourceUrl: "https://developers.ploi.io/crontabs/create-crontab",
|
|
215
|
+
summary: "Create a new cron job on your server.",
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
id: "crontabs.delete-crontab",
|
|
219
|
+
method: "DELETE",
|
|
220
|
+
path: "/api/servers/{server}/crontabs/{id}",
|
|
221
|
+
sourceUrl: "https://developers.ploi.io/crontabs/delete-crontab",
|
|
222
|
+
summary: "Delete a cron job from your server.",
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
id: "crontabs.get-crontab",
|
|
226
|
+
method: "GET",
|
|
227
|
+
path: "/api/servers/{server}/crontabs/{id}",
|
|
228
|
+
sourceUrl: "https://developers.ploi.io/crontabs/get-crontab",
|
|
229
|
+
summary: "Retrieve details of a specific cron job.",
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
id: "crontabs.list-crontabs",
|
|
233
|
+
method: "GET",
|
|
234
|
+
path: "/api/servers/{server}/crontabs",
|
|
235
|
+
sourceUrl: "https://developers.ploi.io/crontabs/list-crontabs",
|
|
236
|
+
summary: "Retrieve a list of all cron jobs on a server.",
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
id: "daemons.create-daemon",
|
|
240
|
+
method: "POST",
|
|
241
|
+
path: "/api/servers/{server}/daemons",
|
|
242
|
+
sourceUrl: "https://developers.ploi.io/daemons/create-daemon",
|
|
243
|
+
summary: "Create a new daemon (background process) on your server.",
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
id: "daemons.delete-daemon",
|
|
247
|
+
method: "DELETE",
|
|
248
|
+
path: "/api/servers/{server}/daemons/{daemon}",
|
|
249
|
+
sourceUrl: "https://developers.ploi.io/daemons/delete-daemon",
|
|
250
|
+
summary: "Delete a daemon from your server.",
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
id: "daemons.get-daemon",
|
|
254
|
+
method: "GET",
|
|
255
|
+
path: "/api/servers/{server}/daemons/{daemon}",
|
|
256
|
+
sourceUrl: "https://developers.ploi.io/daemons/get-daemon",
|
|
257
|
+
summary: "Retrieve details of a specific daemon.",
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
id: "daemons.list-daemons",
|
|
261
|
+
method: "GET",
|
|
262
|
+
path: "/api/servers/{server}/daemons",
|
|
263
|
+
sourceUrl: "https://developers.ploi.io/daemons/list-daemons",
|
|
264
|
+
summary: "Retrieve a list of all daemons on a server.",
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
id: "daemons.pause-daemon",
|
|
268
|
+
method: "POST",
|
|
269
|
+
path: "/api/servers/{server}/daemons/{daemon}/toggle-pause",
|
|
270
|
+
sourceUrl: "https://developers.ploi.io/daemons/pause-daemon",
|
|
271
|
+
summary: "Toggle a daemon between paused and active states.",
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
id: "daemons.restart-daemon",
|
|
275
|
+
method: "POST",
|
|
276
|
+
path: "/api/servers/{server}/daemons/{daemon}/restart",
|
|
277
|
+
sourceUrl: "https://developers.ploi.io/daemons/restart-daemon",
|
|
278
|
+
summary: "Restart a daemon on your server.",
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
id: "database-users.attach-user-to-database",
|
|
282
|
+
method: "POST",
|
|
283
|
+
path: "/api/servers/{server}/databases/{database}/users/attach",
|
|
284
|
+
sourceUrl: "https://developers.ploi.io/database-users/attach-user-to-database",
|
|
285
|
+
summary: "Grant an existing database user access to a specific database.",
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
id: "database-users.create-database-user",
|
|
289
|
+
method: "POST",
|
|
290
|
+
path: "/api/servers/{server}/databases/{database}/users",
|
|
291
|
+
sourceUrl: "https://developers.ploi.io/database-users/create-database-user",
|
|
292
|
+
summary: "Create a new user for a database.",
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
id: "database-users.delete-database-user",
|
|
296
|
+
method: "DELETE",
|
|
297
|
+
path: "/api/servers/{server}/databases/{database}/users/{user}",
|
|
298
|
+
sourceUrl: "https://developers.ploi.io/database-users/delete-database-user",
|
|
299
|
+
summary: "Delete a database user.",
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
id: "database-users.get-database-user",
|
|
303
|
+
method: "GET",
|
|
304
|
+
path: "/api/servers/{server}/databases/{database}/users/{user}",
|
|
305
|
+
sourceUrl: "https://developers.ploi.io/database-users/get-database-user",
|
|
306
|
+
summary: "Retrieve details of a specific database user.",
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
id: "database-users.list-database-users",
|
|
310
|
+
method: "GET",
|
|
311
|
+
path: "/api/servers/{server}/databases/{database}/users",
|
|
312
|
+
sourceUrl: "https://developers.ploi.io/database-users/list-database-users",
|
|
313
|
+
summary: "Retrieve a list of all users for a specific database.",
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
id: "database.create-database-backup",
|
|
317
|
+
method: "POST",
|
|
318
|
+
path: "/api/backups/database",
|
|
319
|
+
sourceUrl: "https://developers.ploi.io/database/create-database-backup",
|
|
320
|
+
summary: "Create a new database backup configuration.",
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
id: "database.delete-database-backup",
|
|
324
|
+
method: "DELETE",
|
|
325
|
+
path: "/api/backups/database/{databaseBackupId}",
|
|
326
|
+
sourceUrl: "https://developers.ploi.io/database/delete-database-backup",
|
|
327
|
+
summary: "Delete a database backup configuration.",
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
id: "database.get-database-backup",
|
|
331
|
+
method: "GET",
|
|
332
|
+
path: "/api/backups/database/{databaseBackupId}",
|
|
333
|
+
sourceUrl: "https://developers.ploi.io/database/get-database-backup",
|
|
334
|
+
summary: "Get a specific database backup.",
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
id: "database.list-database-backups",
|
|
338
|
+
method: "GET",
|
|
339
|
+
path: "/api/backups/database",
|
|
340
|
+
sourceUrl: "https://developers.ploi.io/database/list-database-backups",
|
|
341
|
+
summary: "List all the database backups.",
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
id: "database.run-database-backup",
|
|
345
|
+
method: "POST",
|
|
346
|
+
path: "/api/backups/database/{databaseBackupId}/run",
|
|
347
|
+
sourceUrl: "https://developers.ploi.io/database/run-database-backup",
|
|
348
|
+
summary: "Manually trigger a database backup.",
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
id: "database.update-database-backup",
|
|
352
|
+
method: "PATCH",
|
|
353
|
+
path: "/api/backups/database/{id}",
|
|
354
|
+
sourceUrl: "https://developers.ploi.io/database/update-database-backup",
|
|
355
|
+
summary: "Update an existing database backup configuration.",
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
id: "databases.acknowledge-database",
|
|
359
|
+
method: "POST",
|
|
360
|
+
path: "/api/servers/{server}/databases/acknowledge",
|
|
361
|
+
sourceUrl: "https://developers.ploi.io/databases/acknowledge-database",
|
|
362
|
+
summary: "Let Ploi know about databases created outside of the platform.",
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
id: "databases.create-database",
|
|
366
|
+
method: "POST",
|
|
367
|
+
path: "/api/servers/{server}/databases",
|
|
368
|
+
sourceUrl: "https://developers.ploi.io/databases/create-database",
|
|
369
|
+
summary: "Create a new database on your server.",
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
id: "databases.delete-database",
|
|
373
|
+
method: "DELETE",
|
|
374
|
+
path: "/api/servers/{server}/databases/{id}",
|
|
375
|
+
sourceUrl: "https://developers.ploi.io/databases/delete-database",
|
|
376
|
+
summary: "Delete a database from your server.",
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
id: "databases.duplicate-database",
|
|
380
|
+
method: "POST",
|
|
381
|
+
path: "/api/servers/{server}/databases/{database}/duplicate",
|
|
382
|
+
sourceUrl: "https://developers.ploi.io/databases/duplicate-database",
|
|
383
|
+
summary: "Clone an existing database to a new database.",
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
id: "databases.forget-database",
|
|
387
|
+
method: "DELETE",
|
|
388
|
+
path: "/api/servers/{server}/databases/{id}/forget",
|
|
389
|
+
sourceUrl: "https://developers.ploi.io/databases/forget-database",
|
|
390
|
+
summary: "Remove a database from Ploi without deleting it from the server.",
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
id: "databases.get-database",
|
|
394
|
+
method: "GET",
|
|
395
|
+
path: "/api/servers/{server}/databases/{id}",
|
|
396
|
+
sourceUrl: "https://developers.ploi.io/databases/get-database",
|
|
397
|
+
summary: "Retrieve details of a specific database.",
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
id: "databases.list-databases",
|
|
401
|
+
method: "GET",
|
|
402
|
+
path: "/api/servers/{server}/databases",
|
|
403
|
+
sourceUrl: "https://developers.ploi.io/databases/list-databases",
|
|
404
|
+
summary: "Retrieve a list of all databases on a server.",
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
id: "deployments.deploy-site",
|
|
408
|
+
method: "POST",
|
|
409
|
+
path: "/api/servers/{server}/sites/{site}/deploy",
|
|
410
|
+
sourceUrl: "https://developers.ploi.io/deployments/deploy-site",
|
|
411
|
+
summary: "Deploy your site using the configured deploy script.",
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
id: "deployments.deploy-staging-site-to-production",
|
|
415
|
+
method: "POST",
|
|
416
|
+
path: "/api/servers/{server}/sites/{site}/deploy-to-production",
|
|
417
|
+
sourceUrl: "https://developers.ploi.io/deployments/deploy-staging-site-to-production",
|
|
418
|
+
summary: "Deploy your staging site to production.",
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
id: "deployments.get-deploy-script",
|
|
422
|
+
method: "GET",
|
|
423
|
+
path: "/api/servers/{server}/sites/{site}/deploy/script",
|
|
424
|
+
sourceUrl: "https://developers.ploi.io/deployments/get-deploy-script",
|
|
425
|
+
summary: "Get the deploy script for a site.",
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
id: "deployments.update-deploy-script",
|
|
429
|
+
method: "PATCH",
|
|
430
|
+
path: "/api/servers/{server}/sites/{site}/deploy/script",
|
|
431
|
+
sourceUrl: "https://developers.ploi.io/deployments/update-deploy-script",
|
|
432
|
+
summary: "Update the deploy script for a site.",
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
id: "environment.get-env-from-site",
|
|
436
|
+
method: "GET",
|
|
437
|
+
path: "/api/servers/{server}/sites/{site}/env",
|
|
438
|
+
sourceUrl: "https://developers.ploi.io/environment/get-env-from-site",
|
|
439
|
+
summary: "Get the .env file contents from a site.",
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
id: "environment.update-env-from-site",
|
|
443
|
+
method: "PATCH",
|
|
444
|
+
path: "/api/servers/{server}/sites/{site}/env",
|
|
445
|
+
sourceUrl: "https://developers.ploi.io/environment/update-env-from-site",
|
|
446
|
+
summary: "Update the .env file contents for a site.",
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
id: "fastcgi-cache.disable-fastcgi-cache",
|
|
450
|
+
method: "DELETE",
|
|
451
|
+
path: "/api/servers/{server}/sites/{site}/fastcgi-cache/disable",
|
|
452
|
+
sourceUrl: "https://developers.ploi.io/fastcgi-cache/disable-fastcgi-cache",
|
|
453
|
+
summary: "Disables FastCGI cache for your site.",
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
id: "fastcgi-cache.enable-fastcgi-cache",
|
|
457
|
+
method: "POST",
|
|
458
|
+
path: "/api/servers/{server}/sites/{site}/fastcgi-cache/enable",
|
|
459
|
+
sourceUrl: "https://developers.ploi.io/fastcgi-cache/enable-fastcgi-cache",
|
|
460
|
+
summary: "Enables FastCGI cache for your site.",
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
id: "fastcgi-cache.flush-fastcgi-cache",
|
|
464
|
+
method: "POST",
|
|
465
|
+
path: "/api/servers/{server}/sites/{site}/fastcgi-cache/flush",
|
|
466
|
+
sourceUrl: "https://developers.ploi.io/fastcgi-cache/flush-fastcgi-cache",
|
|
467
|
+
summary: "Flushes FastCGI cache for your site.",
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
id: "getting-started.teapot",
|
|
471
|
+
method: "GET",
|
|
472
|
+
path: "/api/teapot",
|
|
473
|
+
sourceUrl: "https://developers.ploi.io/getting-started/teapot",
|
|
474
|
+
summary: "Return the documented Ploi teapot response.",
|
|
475
|
+
acceptedStatuses: [418],
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
id: "insights.automatically-fix-insight",
|
|
479
|
+
method: "POST",
|
|
480
|
+
path: "/api/servers/{server}/insights/{id}/automatically-fix",
|
|
481
|
+
sourceUrl: "https://developers.ploi.io/insights/automatically-fix-insight",
|
|
482
|
+
summary:
|
|
483
|
+
"Runs the fix for the insight available, if it has already been run it will return an error.",
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
id: "insights.delete-insight",
|
|
487
|
+
method: "DELETE",
|
|
488
|
+
path: "/api/servers/{server}/insights/{id}",
|
|
489
|
+
sourceUrl: "https://developers.ploi.io/insights/delete-insight",
|
|
490
|
+
summary: "Deletes an insight from your server.",
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
id: "insights.detail-insight",
|
|
494
|
+
method: "GET",
|
|
495
|
+
path: "/api/servers/{server}/insights/{id}/detail",
|
|
496
|
+
sourceUrl: "https://developers.ploi.io/insights/detail-insight",
|
|
497
|
+
summary: "Get the explanation details as raw HTML in the response.",
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
id: "insights.get-insight",
|
|
501
|
+
method: "GET",
|
|
502
|
+
path: "/api/servers/{server}/insights/{id}",
|
|
503
|
+
sourceUrl: "https://developers.ploi.io/insights/get-insight",
|
|
504
|
+
summary: "Get the insight details.",
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
id: "insights.ignore-insight",
|
|
508
|
+
method: "POST",
|
|
509
|
+
path: "/api/servers/{server}/insights/{id}/ignore",
|
|
510
|
+
sourceUrl: "https://developers.ploi.io/insights/ignore-insight",
|
|
511
|
+
summary: "Ignores the insight.",
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
id: "insights.list-insights",
|
|
515
|
+
method: "GET",
|
|
516
|
+
path: "/api/servers/{server}/insights",
|
|
517
|
+
sourceUrl: "https://developers.ploi.io/insights/list-insights",
|
|
518
|
+
summary: "List all the insights available in the server.",
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
id: "load-balancers.attach-server",
|
|
522
|
+
method: "PATCH",
|
|
523
|
+
path: "/api/servers/{server}/load-balancer/attach",
|
|
524
|
+
sourceUrl: "https://developers.ploi.io/load-balancers/attach-server",
|
|
525
|
+
summary:
|
|
526
|
+
"Attach a server to a load balancer. This call can take longer than usual because the configuration file is changed on-demand on your server.",
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
id: "load-balancers.detach-server",
|
|
530
|
+
method: "PATCH",
|
|
531
|
+
path: "/api/servers/{server}/load-balancer/detach",
|
|
532
|
+
sourceUrl: "https://developers.ploi.io/load-balancers/detach-server",
|
|
533
|
+
summary:
|
|
534
|
+
"Detach a server from a load balancer. This call can take longer than usual because the configuration file is changed on-demand on your server.",
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
id: "load-balancers.request-certificate-for-domain",
|
|
538
|
+
method: "POST",
|
|
539
|
+
path: "/api/servers/{server}/load-balancer/{domain}/request-certificate",
|
|
540
|
+
sourceUrl: "https://developers.ploi.io/load-balancers/request-certificate-for-domain",
|
|
541
|
+
summary: "Request an SSL certificate for a domain via a load balancer.",
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
id: "load-balancers.revoke-certificate-for-domain",
|
|
545
|
+
method: "DELETE",
|
|
546
|
+
path: "/api/servers/{server}/load-balancer/{domain}/revoke-certificate",
|
|
547
|
+
sourceUrl: "https://developers.ploi.io/load-balancers/revoke-certificate-for-domain",
|
|
548
|
+
summary: "Revoke an SSL certificate for a domain via a load balancer.",
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "monitoring.delete-monitor",
|
|
552
|
+
method: "DELETE",
|
|
553
|
+
path: "/api/servers/{server}/sites/{site}/monitors/{monitor}",
|
|
554
|
+
sourceUrl: "https://developers.ploi.io/monitoring/delete-monitor",
|
|
555
|
+
summary: "Delete a monitor from your site.",
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
id: "monitoring.get-monitor",
|
|
559
|
+
method: "GET",
|
|
560
|
+
path: "/api/servers/{server}/sites/{site}/monitors/{monitor}",
|
|
561
|
+
sourceUrl: "https://developers.ploi.io/monitoring/get-monitor",
|
|
562
|
+
summary: "Retrieve a specific monitor from your site.",
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
id: "monitoring.get-uptime-responses",
|
|
566
|
+
method: "GET",
|
|
567
|
+
path: "/api/servers/{server}/sites/{site}/monitors/{monitor}/uptime-responses",
|
|
568
|
+
sourceUrl: "https://developers.ploi.io/monitoring/get-uptime-responses",
|
|
569
|
+
summary: "Retrieve uptime response data for a specific monitor.",
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
id: "monitoring.list-monitors",
|
|
573
|
+
method: "GET",
|
|
574
|
+
path: "/api/servers/{server}/sites/{site}/monitors",
|
|
575
|
+
sourceUrl: "https://developers.ploi.io/monitoring/list-monitors",
|
|
576
|
+
summary: "Retrieve a list of all monitors for your site.",
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
id: "network-rules.create-network-rule",
|
|
580
|
+
method: "POST",
|
|
581
|
+
path: "/api/servers/{server}/network-rules",
|
|
582
|
+
sourceUrl: "https://developers.ploi.io/network-rules/create-network-rule",
|
|
583
|
+
summary: "Create a new firewall rule on your server.",
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
id: "network-rules.delete-network-rule",
|
|
587
|
+
method: "DELETE",
|
|
588
|
+
path: "/api/servers/{server}/network-rules/{id}",
|
|
589
|
+
sourceUrl: "https://developers.ploi.io/network-rules/delete-network-rule",
|
|
590
|
+
summary: "Delete a firewall rule from your server.",
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
id: "network-rules.get-network-rule",
|
|
594
|
+
method: "GET",
|
|
595
|
+
path: "/api/servers/{server}/network-rules/{id}",
|
|
596
|
+
sourceUrl: "https://developers.ploi.io/network-rules/get-network-rule",
|
|
597
|
+
summary: "Retrieve details of a specific firewall rule.",
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
id: "network-rules.list-network-rules",
|
|
601
|
+
method: "GET",
|
|
602
|
+
path: "/api/servers/{server}/network-rules",
|
|
603
|
+
sourceUrl: "https://developers.ploi.io/network-rules/list-network-rules",
|
|
604
|
+
summary: "Retrieve a list of all firewall rules on a server.",
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
id: "php.disable-opcache",
|
|
608
|
+
method: "DELETE",
|
|
609
|
+
path: "/api/servers/{server}/disable-opcache",
|
|
610
|
+
sourceUrl: "https://developers.ploi.io/php/disable-opcache",
|
|
611
|
+
summary: "Disable OPcache on your server.",
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "php.enable-opcache",
|
|
615
|
+
method: "POST",
|
|
616
|
+
path: "/api/servers/{server}/enable-opcache",
|
|
617
|
+
sourceUrl: "https://developers.ploi.io/php/enable-opcache",
|
|
618
|
+
summary: "Enable OPcache on your server.",
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
id: "php.install-php-version",
|
|
622
|
+
method: "POST",
|
|
623
|
+
path: "/api/servers/{server}/php/install",
|
|
624
|
+
sourceUrl: "https://developers.ploi.io/php/install-php-version",
|
|
625
|
+
summary: "Install a new PHP version on your server if it's not already installed.",
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
id: "php.installed-php-versions",
|
|
629
|
+
method: "GET",
|
|
630
|
+
path: "/api/servers/{server}/php/versions",
|
|
631
|
+
sourceUrl: "https://developers.ploi.io/php/installed-php-versions",
|
|
632
|
+
summary: "Retrieve the installed PHP versions on your server.",
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
id: "php.refresh-opcache",
|
|
636
|
+
method: "POST",
|
|
637
|
+
path: "/api/servers/{server}/refresh-opcache",
|
|
638
|
+
sourceUrl: "https://developers.ploi.io/php/refresh-opcache",
|
|
639
|
+
summary: "Refresh the OPCache on this server.",
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
id: "php.switch-php-cli-version",
|
|
643
|
+
method: "POST",
|
|
644
|
+
path: "/api/servers/{server}/php/cli-version",
|
|
645
|
+
sourceUrl: "https://developers.ploi.io/php/switch-php-cli-version",
|
|
646
|
+
summary: "Change the default PHP CLI version on your server.",
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "projects.create-project",
|
|
650
|
+
method: "POST",
|
|
651
|
+
path: "/api/projects",
|
|
652
|
+
sourceUrl: "https://developers.ploi.io/projects/create-project",
|
|
653
|
+
summary: "Create a new project in your account.",
|
|
654
|
+
},
|
|
655
|
+
{
|
|
656
|
+
id: "projects.delete-project",
|
|
657
|
+
method: "DELETE",
|
|
658
|
+
path: "/api/projects/{project}",
|
|
659
|
+
sourceUrl: "https://developers.ploi.io/projects/delete-project",
|
|
660
|
+
summary: "Delete a project from your account.",
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "projects.get-project",
|
|
664
|
+
method: "GET",
|
|
665
|
+
path: "/api/projects/{project}",
|
|
666
|
+
sourceUrl: "https://developers.ploi.io/projects/get-project",
|
|
667
|
+
summary: "Get a specific project from your account.",
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
id: "projects.list-projects",
|
|
671
|
+
method: "GET",
|
|
672
|
+
path: "/api/projects",
|
|
673
|
+
sourceUrl: "https://developers.ploi.io/projects/list-projects",
|
|
674
|
+
summary: "List all the projects for the current user.",
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
id: "projects.update-project",
|
|
678
|
+
method: "PATCH",
|
|
679
|
+
path: "/api/projects/{project}",
|
|
680
|
+
sourceUrl: "https://developers.ploi.io/projects/update-project",
|
|
681
|
+
summary: "Update an existing project in your account.",
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "queue-workers.create-queue-worker",
|
|
685
|
+
method: "POST",
|
|
686
|
+
path: "/api/servers/{server}/sites/{site}/queues",
|
|
687
|
+
sourceUrl: "https://developers.ploi.io/queue-workers/create-queue-worker",
|
|
688
|
+
summary: "Create a new queue worker for your site.",
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
id: "queue-workers.delete-queue-worker",
|
|
692
|
+
method: "DELETE",
|
|
693
|
+
path: "/api/servers/{server}/sites/{site}/queues/{queueId}",
|
|
694
|
+
sourceUrl: "https://developers.ploi.io/queue-workers/delete-queue-worker",
|
|
695
|
+
summary: "Delete a queue worker from your server.",
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "queue-workers.get-queue-worker",
|
|
699
|
+
method: "GET",
|
|
700
|
+
path: "/api/servers/{server}/sites/{site}/queues/{queueId}",
|
|
701
|
+
sourceUrl: "https://developers.ploi.io/queue-workers/get-queue-worker",
|
|
702
|
+
summary: "Get a specific queue worker.",
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
id: "queue-workers.list-queue-workers",
|
|
706
|
+
method: "GET",
|
|
707
|
+
path: "/api/servers/{server}/sites/{site}/queues",
|
|
708
|
+
sourceUrl: "https://developers.ploi.io/queue-workers/list-queue-workers",
|
|
709
|
+
summary: "List all queue workers for a site.",
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
id: "queue-workers.pause-queue-worker",
|
|
713
|
+
method: "POST",
|
|
714
|
+
path: "/api/servers/{server}/sites/{site}/queues/{queueId}/toggle-pause",
|
|
715
|
+
sourceUrl: "https://developers.ploi.io/queue-workers/pause-queue-worker",
|
|
716
|
+
summary: "Pause or resume a queue worker.",
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
id: "queue-workers.restart-queue-worker",
|
|
720
|
+
method: "POST",
|
|
721
|
+
path: "/api/servers/{server}/sites/{site}/queues/{queueId}/restart",
|
|
722
|
+
sourceUrl: "https://developers.ploi.io/queue-workers/restart-queue-worker",
|
|
723
|
+
summary: "Restart a queue worker on your server.",
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "redirects.create-redirect",
|
|
727
|
+
method: "POST",
|
|
728
|
+
path: "/api/servers/{server}/sites/{site}/redirects",
|
|
729
|
+
sourceUrl: "https://developers.ploi.io/redirects/create-redirect",
|
|
730
|
+
summary: "Create a new redirect for your site.",
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
id: "redirects.delete-redirect",
|
|
734
|
+
method: "DELETE",
|
|
735
|
+
path: "/api/servers/{server}/sites/{site}/redirects/{redirect}",
|
|
736
|
+
sourceUrl: "https://developers.ploi.io/redirects/delete-redirect",
|
|
737
|
+
summary: "Delete a redirect from your site.",
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "redirects.get-redirect",
|
|
741
|
+
method: "GET",
|
|
742
|
+
path: "/api/servers/{server}/sites/{site}/redirects/{redirect}",
|
|
743
|
+
sourceUrl: "https://developers.ploi.io/redirects/get-redirect",
|
|
744
|
+
summary: "Get a specific redirect.",
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
id: "redirects.list-redirects",
|
|
748
|
+
method: "GET",
|
|
749
|
+
path: "/api/servers/{server}/sites/{site}/redirects",
|
|
750
|
+
sourceUrl: "https://developers.ploi.io/redirects/list-redirects",
|
|
751
|
+
summary: "List all redirects for a site.",
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
id: "repositories.custom-deployment",
|
|
755
|
+
method: "POST",
|
|
756
|
+
path: "/api/servers/{server}/sites/{site}/repository/custom-deployments",
|
|
757
|
+
sourceUrl: "https://developers.ploi.io/repositories/custom-deployment",
|
|
758
|
+
summary: "Enable custom deployments on your site.",
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
id: "repositories.delete-repository",
|
|
762
|
+
method: "DELETE",
|
|
763
|
+
path: "/api/servers/{server}/sites/{site}/repository",
|
|
764
|
+
sourceUrl: "https://developers.ploi.io/repositories/delete-repository",
|
|
765
|
+
summary: "Delete a repository from your site.",
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "repositories.get-repository",
|
|
769
|
+
method: "GET",
|
|
770
|
+
path: "/api/servers/{server}/sites/{site}/repository",
|
|
771
|
+
sourceUrl: "https://developers.ploi.io/repositories/get-repository",
|
|
772
|
+
summary: "Get repository information for a site.",
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
id: "repositories.install-repository",
|
|
776
|
+
method: "POST",
|
|
777
|
+
path: "/api/servers/{server}/sites/{site}/repository",
|
|
778
|
+
sourceUrl: "https://developers.ploi.io/repositories/install-repository",
|
|
779
|
+
summary: "Install a repository on your site.",
|
|
780
|
+
},
|
|
781
|
+
{
|
|
782
|
+
id: "repositories.toggle-quick-deploy",
|
|
783
|
+
method: "POST",
|
|
784
|
+
path: "/api/servers/{server}/sites/{site}/repository/quick-deploy",
|
|
785
|
+
sourceUrl: "https://developers.ploi.io/repositories/toggle-quick-deploy",
|
|
786
|
+
summary: "Enable or disable quick deploy for your repository.",
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
id: "script-actions.create-action",
|
|
790
|
+
method: "POST",
|
|
791
|
+
path: "/api/scripts/{script}/actions",
|
|
792
|
+
sourceUrl: "https://developers.ploi.io/script-actions/create-action",
|
|
793
|
+
summary: "Wire a script to a server event.",
|
|
794
|
+
},
|
|
795
|
+
{
|
|
796
|
+
id: "script-actions.delete-action",
|
|
797
|
+
method: "DELETE",
|
|
798
|
+
path: "/api/scripts/{script}/actions/{action}",
|
|
799
|
+
sourceUrl: "https://developers.ploi.io/script-actions/delete-action",
|
|
800
|
+
summary: "Remove an action and tear down its systemd units.",
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
id: "script-actions.get-action",
|
|
804
|
+
method: "GET",
|
|
805
|
+
path: "/api/scripts/{script}/actions/{action}",
|
|
806
|
+
sourceUrl: "https://developers.ploi.io/script-actions/get-action",
|
|
807
|
+
summary: "Fetch a single action with its per-server install status.",
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
id: "script-actions.list-actions",
|
|
811
|
+
method: "GET",
|
|
812
|
+
path: "/api/scripts/{script}/actions",
|
|
813
|
+
sourceUrl: "https://developers.ploi.io/script-actions/list-actions",
|
|
814
|
+
summary: "List all event-driven actions attached to a script.",
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
id: "script-actions.rotate-action-secret",
|
|
818
|
+
method: "POST",
|
|
819
|
+
path: "/api/scripts/{script}/actions/{action}/rotate-secret",
|
|
820
|
+
sourceUrl: "https://developers.ploi.io/script-actions/rotate-action-secret",
|
|
821
|
+
summary: "Generate a fresh per-action webhook secret and re-issue every URL.",
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
id: "script-actions.toggle-action",
|
|
825
|
+
method: "POST",
|
|
826
|
+
path: "/api/scripts/{script}/actions/{action}/toggle",
|
|
827
|
+
sourceUrl: "https://developers.ploi.io/script-actions/toggle-action",
|
|
828
|
+
summary: "Pause or resume an action.",
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
id: "script-actions.update-action",
|
|
832
|
+
method: "PATCH",
|
|
833
|
+
path: "/api/scripts/{script}/actions/{action}",
|
|
834
|
+
sourceUrl: "https://developers.ploi.io/script-actions/update-action",
|
|
835
|
+
summary: "Change the trigger, delay, or server list on an existing action.",
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
id: "script-schedules.create-schedule",
|
|
839
|
+
method: "POST",
|
|
840
|
+
path: "/api/scripts/{script}/schedules",
|
|
841
|
+
sourceUrl: "https://developers.ploi.io/script-schedules/create-schedule",
|
|
842
|
+
summary: "Add a new cron schedule to a script.",
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
id: "script-schedules.delete-schedule",
|
|
846
|
+
method: "DELETE",
|
|
847
|
+
path: "/api/scripts/{script}/schedules/{schedule}",
|
|
848
|
+
sourceUrl: "https://developers.ploi.io/script-schedules/delete-schedule",
|
|
849
|
+
summary: "Permanently remove a schedule from a script.",
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
id: "script-schedules.get-schedule",
|
|
853
|
+
method: "GET",
|
|
854
|
+
path: "/api/scripts/{script}/schedules/{schedule}",
|
|
855
|
+
sourceUrl: "https://developers.ploi.io/script-schedules/get-schedule",
|
|
856
|
+
summary: "Fetch a single schedule attached to a script.",
|
|
857
|
+
},
|
|
858
|
+
{
|
|
859
|
+
id: "script-schedules.list-schedules",
|
|
860
|
+
method: "GET",
|
|
861
|
+
path: "/api/scripts/{script}/schedules",
|
|
862
|
+
sourceUrl: "https://developers.ploi.io/script-schedules/list-schedules",
|
|
863
|
+
summary: "List all cron schedules attached to a script.",
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
id: "script-schedules.toggle-schedule",
|
|
867
|
+
method: "POST",
|
|
868
|
+
path: "/api/scripts/{script}/schedules/{schedule}/toggle",
|
|
869
|
+
sourceUrl: "https://developers.ploi.io/script-schedules/toggle-schedule",
|
|
870
|
+
summary: "Pause or resume a schedule.",
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
id: "script-schedules.update-schedule",
|
|
874
|
+
method: "PATCH",
|
|
875
|
+
path: "/api/scripts/{script}/schedules/{schedule}",
|
|
876
|
+
sourceUrl: "https://developers.ploi.io/script-schedules/update-schedule",
|
|
877
|
+
summary: "Replace the cron expression and server list of an existing schedule.",
|
|
878
|
+
},
|
|
879
|
+
{
|
|
880
|
+
id: "scripts.create-script",
|
|
881
|
+
method: "POST",
|
|
882
|
+
path: "/api/scripts",
|
|
883
|
+
sourceUrl: "https://developers.ploi.io/scripts/create-script",
|
|
884
|
+
summary: "Create a new script in your account.",
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
id: "scripts.delete-script",
|
|
888
|
+
method: "DELETE",
|
|
889
|
+
path: "/api/scripts/{script}",
|
|
890
|
+
sourceUrl: "https://developers.ploi.io/scripts/delete-script",
|
|
891
|
+
summary: "Delete a script from your account.",
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
id: "scripts.get-script",
|
|
895
|
+
method: "GET",
|
|
896
|
+
path: "/api/scripts/{script}",
|
|
897
|
+
sourceUrl: "https://developers.ploi.io/scripts/get-script",
|
|
898
|
+
summary: "Get a specific script from your account.",
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
id: "scripts.get-script-execution",
|
|
902
|
+
method: "GET",
|
|
903
|
+
path: "/api/servers/{server}/scripts/run/{execution}",
|
|
904
|
+
sourceUrl: "https://developers.ploi.io/scripts/get-script-execution",
|
|
905
|
+
summary: "Poll the status and output of a one-off script execution.",
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
id: "scripts.list-scripts",
|
|
909
|
+
method: "GET",
|
|
910
|
+
path: "/api/scripts",
|
|
911
|
+
sourceUrl: "https://developers.ploi.io/scripts/list-scripts",
|
|
912
|
+
summary: "List all the scripts for the current user.",
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
id: "scripts.run-one-off-script",
|
|
916
|
+
method: "POST",
|
|
917
|
+
path: "/api/servers/{server}/scripts/run",
|
|
918
|
+
sourceUrl: "https://developers.ploi.io/scripts/run-one-off-script",
|
|
919
|
+
summary: "Run a script on a server without creating a reusable script resource.",
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
id: "scripts.run-script",
|
|
923
|
+
method: "POST",
|
|
924
|
+
path: "/api/scripts/{script}/run",
|
|
925
|
+
sourceUrl: "https://developers.ploi.io/scripts/run-script",
|
|
926
|
+
summary: "Run a script on specific servers.",
|
|
927
|
+
},
|
|
928
|
+
{
|
|
929
|
+
id: "scripts.update-script",
|
|
930
|
+
method: "PATCH",
|
|
931
|
+
path: "/api/scripts/{script}",
|
|
932
|
+
sourceUrl: "https://developers.ploi.io/scripts/update-script",
|
|
933
|
+
summary: "Update an existing script in your account.",
|
|
934
|
+
},
|
|
935
|
+
{
|
|
936
|
+
id: "servers.create-custom-server",
|
|
937
|
+
method: "POST",
|
|
938
|
+
path: "/api/servers/custom",
|
|
939
|
+
sourceUrl: "https://developers.ploi.io/servers/create-custom-server",
|
|
940
|
+
summary: "Connect and configure an existing server that you already own.",
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
id: "servers.create-server",
|
|
944
|
+
method: "POST",
|
|
945
|
+
path: "/api/servers",
|
|
946
|
+
sourceUrl: "https://developers.ploi.io/servers/create-server",
|
|
947
|
+
summary:
|
|
948
|
+
"Creates a new server in your account. To be able to do this properly you will need 3 key values: plan, region and credential.",
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
id: "servers.delete-server",
|
|
952
|
+
method: "DELETE",
|
|
953
|
+
path: "/api/servers/{server}",
|
|
954
|
+
sourceUrl: "https://developers.ploi.io/servers/delete-server",
|
|
955
|
+
summary: "Delete a server from your account.",
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
id: "servers.get-server",
|
|
959
|
+
method: "GET",
|
|
960
|
+
path: "/api/servers/{id}",
|
|
961
|
+
sourceUrl: "https://developers.ploi.io/servers/get-server",
|
|
962
|
+
summary: "Retrieve details of a specific server in your account.",
|
|
963
|
+
},
|
|
964
|
+
{
|
|
965
|
+
id: "servers.list-servers",
|
|
966
|
+
method: "GET",
|
|
967
|
+
path: "/api/servers",
|
|
968
|
+
sourceUrl: "https://developers.ploi.io/servers/list-servers",
|
|
969
|
+
summary: "Retrieve a list of all servers in your account.",
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
id: "servers.logs-server",
|
|
973
|
+
method: "GET",
|
|
974
|
+
path: "/api/servers/{id}/logs",
|
|
975
|
+
sourceUrl: "https://developers.ploi.io/servers/logs-server",
|
|
976
|
+
summary: "Retrieve activity logs for a specific server.",
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
id: "servers.monitored",
|
|
980
|
+
method: "GET",
|
|
981
|
+
path: "/api/servers/monitored",
|
|
982
|
+
sourceUrl: "https://developers.ploi.io/servers/monitored",
|
|
983
|
+
summary: "Get all monitored servers with their statistics in a single call.",
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
id: "servers.monitoring",
|
|
987
|
+
method: "GET",
|
|
988
|
+
path: "/api/servers/{server}/monitor",
|
|
989
|
+
sourceUrl: "https://developers.ploi.io/servers/monitoring",
|
|
990
|
+
summary: "Get the latest monitoring statistics for a specific server.",
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
id: "servers.restart-server",
|
|
994
|
+
method: "POST",
|
|
995
|
+
path: "/api/servers/{id}/restart",
|
|
996
|
+
sourceUrl: "https://developers.ploi.io/servers/restart-server",
|
|
997
|
+
summary: "Reboot a server.",
|
|
998
|
+
},
|
|
999
|
+
{
|
|
1000
|
+
id: "servers.start-installation",
|
|
1001
|
+
method: "POST",
|
|
1002
|
+
path: "/api/servers/custom/{id}/start",
|
|
1003
|
+
sourceUrl: "https://developers.ploi.io/servers/create-custom-server",
|
|
1004
|
+
summary: "Start installation after adding Ploi's public key to the custom server.",
|
|
1005
|
+
},
|
|
1006
|
+
{
|
|
1007
|
+
id: "servers.update-server",
|
|
1008
|
+
method: "PATCH",
|
|
1009
|
+
path: "/api/servers/{server}",
|
|
1010
|
+
sourceUrl: "https://developers.ploi.io/servers/update-server",
|
|
1011
|
+
summary: "Update details of an existing server.",
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
id: "services.install-wordpress-cli",
|
|
1015
|
+
method: "POST",
|
|
1016
|
+
path: "/api/servers/{server}/install/wp-cli",
|
|
1017
|
+
sourceUrl: "https://developers.ploi.io/services/install-wordpress-cli",
|
|
1018
|
+
summary: "Installs the WordPress CLI on your server.",
|
|
1019
|
+
},
|
|
1020
|
+
{
|
|
1021
|
+
id: "services.reload-service",
|
|
1022
|
+
method: "POST",
|
|
1023
|
+
path: "/api/servers/{server}/services/{service}/reload",
|
|
1024
|
+
sourceUrl: "https://developers.ploi.io/services/reload-service",
|
|
1025
|
+
summary:
|
|
1026
|
+
'Gracefully reloads a service on your server without dropping in-flight connections, making it safe for automated workflows such as SSL renewals and deploys. Possible values: "nginx", "database", "supervisor".',
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
id: "services.restart-service",
|
|
1030
|
+
method: "POST",
|
|
1031
|
+
path: "/api/servers/{server}/services/{service}/restart",
|
|
1032
|
+
sourceUrl: "https://developers.ploi.io/services/restart-service",
|
|
1033
|
+
summary: 'Restarts a service on your server. Possible values: "mysql", "nginx", "supervisor".',
|
|
1034
|
+
},
|
|
1035
|
+
{
|
|
1036
|
+
id: "services.run-wp-cli-command",
|
|
1037
|
+
method: "POST",
|
|
1038
|
+
path: "/api/servers/{server}/wp-cli/run",
|
|
1039
|
+
sourceUrl: "https://developers.ploi.io/services/run-wp-cli-command",
|
|
1040
|
+
summary: "Runs a WordPress CLI command on your server.",
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
id: "services.uninstall-wordpress-cli",
|
|
1044
|
+
method: "DELETE",
|
|
1045
|
+
path: "/api/servers/{server}/uninstall/wp-cli",
|
|
1046
|
+
sourceUrl: "https://developers.ploi.io/services/uninstall-wordpress-cli",
|
|
1047
|
+
summary: "Uninstalls the WordPress CLI from your server.",
|
|
1048
|
+
},
|
|
1049
|
+
{
|
|
1050
|
+
id: "site.create-site-file-backup",
|
|
1051
|
+
method: "POST",
|
|
1052
|
+
path: "/api/backups/file",
|
|
1053
|
+
sourceUrl: "https://developers.ploi.io/site/create-site-file-backup",
|
|
1054
|
+
summary: "Create a new site file backup.",
|
|
1055
|
+
},
|
|
1056
|
+
{
|
|
1057
|
+
id: "site.delete-site-file-backup",
|
|
1058
|
+
method: "DELETE",
|
|
1059
|
+
path: "/api/backups/file/{fileBackupId}",
|
|
1060
|
+
sourceUrl: "https://developers.ploi.io/site/delete-site-file-backup",
|
|
1061
|
+
summary: "Delete a site file backup configuration.",
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
id: "site.get-site-file-backup",
|
|
1065
|
+
method: "GET",
|
|
1066
|
+
path: "/api/backups/file/{fileBackupId}",
|
|
1067
|
+
sourceUrl: "https://developers.ploi.io/site/get-site-file-backup",
|
|
1068
|
+
summary: "Get a specific site file backup.",
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
id: "site.list-site-file-backups",
|
|
1072
|
+
method: "GET",
|
|
1073
|
+
path: "/api/backups/file",
|
|
1074
|
+
sourceUrl: "https://developers.ploi.io/site/list-site-file-backups",
|
|
1075
|
+
summary: "List all the site file backups.",
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
id: "site.run-site-file-backup",
|
|
1079
|
+
method: "POST",
|
|
1080
|
+
path: "/api/backups/file/{fileBackupId}/run",
|
|
1081
|
+
sourceUrl: "https://developers.ploi.io/site/run-site-file-backup",
|
|
1082
|
+
summary: "Run a site file backup immediately.",
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
id: "site.update-site-file-backup",
|
|
1086
|
+
method: "PATCH",
|
|
1087
|
+
path: "/api/backups/file/{id}",
|
|
1088
|
+
sourceUrl: "https://developers.ploi.io/site/update-site-file-backup",
|
|
1089
|
+
summary: "Update an existing site file backup.",
|
|
1090
|
+
},
|
|
1091
|
+
{
|
|
1092
|
+
id: "sites.change-php-version",
|
|
1093
|
+
method: "POST",
|
|
1094
|
+
path: "/api/servers/{server}/sites/{site}/php-version",
|
|
1095
|
+
sourceUrl: "https://developers.ploi.io/sites/change-php-version",
|
|
1096
|
+
summary: "Change the PHP version for a site.",
|
|
1097
|
+
},
|
|
1098
|
+
{
|
|
1099
|
+
id: "sites.clone-site",
|
|
1100
|
+
method: "POST",
|
|
1101
|
+
path: "/api/servers/{server}/sites/{site}/clone",
|
|
1102
|
+
sourceUrl: "https://developers.ploi.io/sites/clone-site",
|
|
1103
|
+
summary: "Clone a site to another server.",
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
id: "sites.create-site",
|
|
1107
|
+
method: "POST",
|
|
1108
|
+
path: "/api/servers/{server}/sites",
|
|
1109
|
+
sourceUrl: "https://developers.ploi.io/sites/create-site",
|
|
1110
|
+
summary: "Create a new site on your server.",
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
id: "sites.delete-site",
|
|
1114
|
+
method: "DELETE",
|
|
1115
|
+
path: "/api/servers/{server}/sites/{site}",
|
|
1116
|
+
sourceUrl: "https://developers.ploi.io/sites/delete-site",
|
|
1117
|
+
summary: "Delete a site from your server.",
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
id: "sites.disable-test-domain",
|
|
1121
|
+
method: "DELETE",
|
|
1122
|
+
path: "/api/servers/{server}/sites/{site}/test-domain",
|
|
1123
|
+
sourceUrl: "https://developers.ploi.io/sites/disable-test-domain",
|
|
1124
|
+
summary: "Disable the test domain for a site.",
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
id: "sites.enable-test-domain",
|
|
1128
|
+
method: "POST",
|
|
1129
|
+
path: "/api/servers/{server}/sites/{site}/test-domain",
|
|
1130
|
+
sourceUrl: "https://developers.ploi.io/sites/enable-test-domain",
|
|
1131
|
+
summary: "Enable a test domain for your site.",
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
id: "sites.get-log-site",
|
|
1135
|
+
method: "GET",
|
|
1136
|
+
path: "/api/servers/{server}/sites/{site}/log/{log}",
|
|
1137
|
+
sourceUrl: "https://developers.ploi.io/sites/get-log-site",
|
|
1138
|
+
summary: "Get a specific log entry with full content.",
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
id: "sites.get-nginx-configuration",
|
|
1142
|
+
method: "GET",
|
|
1143
|
+
path: "/api/servers/{server}/sites/{site}/nginx-configuration",
|
|
1144
|
+
sourceUrl: "https://developers.ploi.io/sites/get-nginx-configuration",
|
|
1145
|
+
summary: "Get the webserver configuration for a site.",
|
|
1146
|
+
},
|
|
1147
|
+
{
|
|
1148
|
+
id: "sites.get-site",
|
|
1149
|
+
method: "GET",
|
|
1150
|
+
path: "/api/servers/{server}/sites/{site}",
|
|
1151
|
+
sourceUrl: "https://developers.ploi.io/sites/get-site",
|
|
1152
|
+
summary: "Get a single site from a server.",
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
id: "sites.get-test-domain",
|
|
1156
|
+
method: "GET",
|
|
1157
|
+
path: "/api/servers/{server}/sites/{site}/test-domain",
|
|
1158
|
+
sourceUrl: "https://developers.ploi.io/sites/get-test-domain",
|
|
1159
|
+
summary: "Get the test domain details for a site.",
|
|
1160
|
+
},
|
|
1161
|
+
{
|
|
1162
|
+
id: "sites.laravel-horizon-statistics",
|
|
1163
|
+
method: "GET",
|
|
1164
|
+
path: "/api/servers/{server}/sites/laravel/horizon/{type}",
|
|
1165
|
+
sourceUrl: "https://developers.ploi.io/sites/laravel-horizon-statistics",
|
|
1166
|
+
summary: "Get Laravel Horizon statistics for your site.",
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
id: "sites.list-sites",
|
|
1170
|
+
method: "GET",
|
|
1171
|
+
path: "/api/servers/{server}/sites",
|
|
1172
|
+
sourceUrl: "https://developers.ploi.io/sites/list-sites",
|
|
1173
|
+
summary: "List all sites on a specific server.",
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
id: "sites.log-site",
|
|
1177
|
+
method: "GET",
|
|
1178
|
+
path: "/api/servers/{server}/sites/{site}/log",
|
|
1179
|
+
sourceUrl: "https://developers.ploi.io/sites/log-site",
|
|
1180
|
+
summary: "Get the latest logs from a site.",
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
id: "sites.reset-site-permissions",
|
|
1184
|
+
method: "POST",
|
|
1185
|
+
path: "/api/servers/{server}/sites/{site}/permission-reset",
|
|
1186
|
+
sourceUrl: "https://developers.ploi.io/sites/reset-site-permissions",
|
|
1187
|
+
summary: "Reset file and directory permissions for your site.",
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
id: "sites.resume-site",
|
|
1191
|
+
method: "POST",
|
|
1192
|
+
path: "/api/servers/{server}/sites/{site}/resume",
|
|
1193
|
+
sourceUrl: "https://developers.ploi.io/sites/resume-site",
|
|
1194
|
+
summary: "Resume a suspended website on your server.",
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
id: "sites.robot-access",
|
|
1198
|
+
method: "PATCH",
|
|
1199
|
+
path: "/api/servers/{server}/sites/{site}",
|
|
1200
|
+
sourceUrl: "https://developers.ploi.io/sites/robot-access",
|
|
1201
|
+
summary: "Control search robot access to your site.",
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
id: "sites.suspend-site",
|
|
1205
|
+
method: "POST",
|
|
1206
|
+
path: "/api/servers/{server}/sites/{site}/suspend",
|
|
1207
|
+
sourceUrl: "https://developers.ploi.io/sites/suspend-site",
|
|
1208
|
+
summary: "Suspend a website on your server.",
|
|
1209
|
+
},
|
|
1210
|
+
{
|
|
1211
|
+
id: "sites.update-nginx-configuration",
|
|
1212
|
+
method: "PATCH",
|
|
1213
|
+
path: "/api/servers/{server}/sites/{site}/nginx-configuration",
|
|
1214
|
+
sourceUrl: "https://developers.ploi.io/sites/update-nginx-configuration",
|
|
1215
|
+
summary: "Update the webserver configuration for a site.",
|
|
1216
|
+
},
|
|
1217
|
+
{
|
|
1218
|
+
id: "sites.update-site",
|
|
1219
|
+
method: "PATCH",
|
|
1220
|
+
path: "/api/servers/{server}/sites/{site}",
|
|
1221
|
+
sourceUrl: "https://developers.ploi.io/sites/update-site",
|
|
1222
|
+
summary: "Update a site on your server.",
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
id: "ssh-keys.create-ssh-key",
|
|
1226
|
+
method: "POST",
|
|
1227
|
+
path: "/api/servers/{server}/ssh-keys",
|
|
1228
|
+
sourceUrl: "https://developers.ploi.io/ssh-keys/create-ssh-key",
|
|
1229
|
+
summary: "Add a new SSH key to a server.",
|
|
1230
|
+
},
|
|
1231
|
+
{
|
|
1232
|
+
id: "ssh-keys.delete-ssh-key",
|
|
1233
|
+
method: "DELETE",
|
|
1234
|
+
path: "/api/servers/{server}/ssh-keys/{sshKey}",
|
|
1235
|
+
sourceUrl: "https://developers.ploi.io/ssh-keys/delete-ssh-key",
|
|
1236
|
+
summary: "Remove an SSH key from a server.",
|
|
1237
|
+
},
|
|
1238
|
+
{
|
|
1239
|
+
id: "ssh-keys.get-ssh-key",
|
|
1240
|
+
method: "GET",
|
|
1241
|
+
path: "/api/servers/{server}/ssh-keys/{sshKey}",
|
|
1242
|
+
sourceUrl: "https://developers.ploi.io/ssh-keys/get-ssh-key",
|
|
1243
|
+
summary: "Retrieve details of a specific SSH key.",
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
id: "ssh-keys.list-ssh-keys",
|
|
1247
|
+
method: "GET",
|
|
1248
|
+
path: "/api/servers/{server}/ssh-keys",
|
|
1249
|
+
sourceUrl: "https://developers.ploi.io/ssh-keys/list-ssh-keys",
|
|
1250
|
+
summary: "Retrieve a list of all SSH keys available on a server.",
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
id: "status-pages.create-status-page-incident",
|
|
1254
|
+
method: "POST",
|
|
1255
|
+
path: "/api/status-pages/{statusPage}/incidents",
|
|
1256
|
+
sourceUrl: "https://developers.ploi.io/status-pages/create-status-page-incident",
|
|
1257
|
+
summary: "Creates a new incident in your status page",
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
id: "status-pages.delete-status-page-incident",
|
|
1261
|
+
method: "DELETE",
|
|
1262
|
+
path: "/api/status-pages/{statusPage}/incident/{incident}",
|
|
1263
|
+
sourceUrl: "https://developers.ploi.io/status-pages/delete-status-page-incident",
|
|
1264
|
+
summary: "Delete a incident in your status page",
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
id: "status-pages.get-status-page",
|
|
1268
|
+
method: "GET",
|
|
1269
|
+
path: "/api/status-pages/{statusPage}",
|
|
1270
|
+
sourceUrl: "https://developers.ploi.io/status-pages/get-status-page",
|
|
1271
|
+
summary: "Get the selected status page",
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
id: "status-pages.get-status-page-incidents",
|
|
1275
|
+
method: "GET",
|
|
1276
|
+
path: "/api/status-pages/{statusPage}/incidents",
|
|
1277
|
+
sourceUrl: "https://developers.ploi.io/status-pages/get-status-page-incidents",
|
|
1278
|
+
summary: "Get all the incidents for a status page ordered by latest entry",
|
|
1279
|
+
},
|
|
1280
|
+
{
|
|
1281
|
+
id: "status-pages.list-status-pages",
|
|
1282
|
+
method: "GET",
|
|
1283
|
+
path: "/api/status-pages",
|
|
1284
|
+
sourceUrl: "https://developers.ploi.io/status-pages/list-status-pages",
|
|
1285
|
+
summary: "List all your status pages",
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
id: "system-users.create-system-user",
|
|
1289
|
+
method: "POST",
|
|
1290
|
+
path: "/api/servers/{server}/system-users",
|
|
1291
|
+
sourceUrl: "https://developers.ploi.io/system-users/create-system-user",
|
|
1292
|
+
summary: "Create a new system user on your server.",
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
id: "system-users.delete-system-user",
|
|
1296
|
+
method: "DELETE",
|
|
1297
|
+
path: "/api/servers/{server}/system-users/{systemUser}",
|
|
1298
|
+
sourceUrl: "https://developers.ploi.io/system-users/delete-system-user",
|
|
1299
|
+
summary: "Delete a system user from your server.",
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
id: "system-users.get-system-user",
|
|
1303
|
+
method: "GET",
|
|
1304
|
+
path: "/api/servers/{server}/system-users/{systemUser}",
|
|
1305
|
+
sourceUrl: "https://developers.ploi.io/system-users/get-system-user",
|
|
1306
|
+
summary: "Retrieve details of a specific system user.",
|
|
1307
|
+
},
|
|
1308
|
+
{
|
|
1309
|
+
id: "system-users.list-system-users",
|
|
1310
|
+
method: "GET",
|
|
1311
|
+
path: "/api/servers/{server}/system-users",
|
|
1312
|
+
sourceUrl: "https://developers.ploi.io/system-users/list-system-users",
|
|
1313
|
+
summary: "Retrieve a list of all system users on a server.",
|
|
1314
|
+
},
|
|
1315
|
+
{
|
|
1316
|
+
id: "tenants.create-tenant",
|
|
1317
|
+
method: "POST",
|
|
1318
|
+
path: "/api/servers/{server}/sites/{site}/tenants",
|
|
1319
|
+
sourceUrl: "https://developers.ploi.io/tenants/create-tenant",
|
|
1320
|
+
summary: "Adds a tenant to your site.",
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
id: "tenants.delete-certificate",
|
|
1324
|
+
method: "POST",
|
|
1325
|
+
path: "/api/servers/{server}/sites/{site}/tenants/{tenant}/revoke-certificate",
|
|
1326
|
+
sourceUrl: "https://developers.ploi.io/tenants/delete-certificate",
|
|
1327
|
+
summary: "Deletes a certificate for your tenant.",
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
id: "tenants.delete-tenant",
|
|
1331
|
+
method: "DELETE",
|
|
1332
|
+
path: "/api/servers/{server}/sites/{site}/tenants/{tenant}",
|
|
1333
|
+
sourceUrl: "https://developers.ploi.io/tenants/delete-tenant",
|
|
1334
|
+
summary: "Delete a tenant from a site.",
|
|
1335
|
+
},
|
|
1336
|
+
{
|
|
1337
|
+
id: "tenants.get-nginx-configuration-tenant",
|
|
1338
|
+
method: "GET",
|
|
1339
|
+
path: "/api/servers/{server}/sites/{site}/tenants/{tenant}/nginx-configuration",
|
|
1340
|
+
sourceUrl: "https://developers.ploi.io/tenants/get-nginx-configuration-tenant",
|
|
1341
|
+
summary: "Get the webserver configuration for a specific tenant.",
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
id: "tenants.list-tenants",
|
|
1345
|
+
method: "GET",
|
|
1346
|
+
path: "/api/servers/{server}/sites/{site}/tenants",
|
|
1347
|
+
sourceUrl: "https://developers.ploi.io/tenants/list-tenants",
|
|
1348
|
+
summary: "List all the tenants for a site.",
|
|
1349
|
+
},
|
|
1350
|
+
{
|
|
1351
|
+
id: "tenants.request-certificate",
|
|
1352
|
+
method: "POST",
|
|
1353
|
+
path: "/api/servers/{server}/sites/{site}/tenants/{tenant}/request-certificate",
|
|
1354
|
+
sourceUrl: "https://developers.ploi.io/tenants/request-certificate",
|
|
1355
|
+
summary: "Create a certificate for your tenant.",
|
|
1356
|
+
},
|
|
1357
|
+
{
|
|
1358
|
+
id: "tenants.update-nginx-configuration-tenant",
|
|
1359
|
+
method: "PATCH",
|
|
1360
|
+
path: "/api/servers/{server}/sites/{site}/tenants/{tenant}/nginx-configuration",
|
|
1361
|
+
sourceUrl: "https://developers.ploi.io/tenants/update-nginx-configuration-tenant",
|
|
1362
|
+
summary: "Updates the webservers configuration file for a tenant website in NGINX.",
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
id: "user.get-backup-configuration",
|
|
1366
|
+
method: "GET",
|
|
1367
|
+
path: "/api/user/backup-configurations/{backupConfiguration}",
|
|
1368
|
+
sourceUrl: "https://developers.ploi.io/user/get-backup-configuration",
|
|
1369
|
+
summary: "Get a specific backup configuration from your account.",
|
|
1370
|
+
},
|
|
1371
|
+
{
|
|
1372
|
+
id: "user.get-server-provider",
|
|
1373
|
+
method: "GET",
|
|
1374
|
+
path: "/api/user/server-providers/{provider}",
|
|
1375
|
+
sourceUrl: "https://developers.ploi.io/user/get-server-provider",
|
|
1376
|
+
summary: "Get a specific server provider from your account.",
|
|
1377
|
+
},
|
|
1378
|
+
{
|
|
1379
|
+
id: "user.information",
|
|
1380
|
+
method: "GET",
|
|
1381
|
+
path: "/api/user",
|
|
1382
|
+
sourceUrl: "https://developers.ploi.io/user/information",
|
|
1383
|
+
summary: "Get your own user information.",
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
id: "user.list-backup-configurations",
|
|
1387
|
+
method: "GET",
|
|
1388
|
+
path: "/api/user/backup-configurations",
|
|
1389
|
+
sourceUrl: "https://developers.ploi.io/user/list-backup-configurations",
|
|
1390
|
+
summary: "List all backup configurations linked to your account.",
|
|
1391
|
+
},
|
|
1392
|
+
{
|
|
1393
|
+
id: "user.list-server-providers",
|
|
1394
|
+
method: "GET",
|
|
1395
|
+
path: "/api/user/server-providers",
|
|
1396
|
+
sourceUrl: "https://developers.ploi.io/user/list-server-providers",
|
|
1397
|
+
summary: "List all server providers linked to your account.",
|
|
1398
|
+
},
|
|
1399
|
+
{
|
|
1400
|
+
id: "user.list-source-control-providers",
|
|
1401
|
+
method: "GET",
|
|
1402
|
+
path: "/api/user/source-control",
|
|
1403
|
+
sourceUrl: "https://developers.ploi.io/user/list-source-control-providers",
|
|
1404
|
+
summary: "List all source control providers linked to your account.",
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
id: "user.repositories-for-source-control-providers",
|
|
1408
|
+
method: "GET",
|
|
1409
|
+
path: "/api/user/source-control/{provider}/repositories",
|
|
1410
|
+
sourceUrl: "https://developers.ploi.io/user/repositories-for-source-control-providers",
|
|
1411
|
+
summary: "Get the repositories for a specific source control provider.",
|
|
1412
|
+
},
|
|
1413
|
+
{
|
|
1414
|
+
id: "user.show-source-control-providers",
|
|
1415
|
+
method: "GET",
|
|
1416
|
+
path: "/api/user/source-control/{provider}",
|
|
1417
|
+
sourceUrl: "https://developers.ploi.io/user/show-source-control-providers",
|
|
1418
|
+
summary: "Get a specific source control provider from your account.",
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
id: "webserver-templates.get-webserver-template",
|
|
1422
|
+
method: "GET",
|
|
1423
|
+
path: "/api/webserver-templates/{id}",
|
|
1424
|
+
sourceUrl: "https://developers.ploi.io/webserver-templates/get-webserver-template",
|
|
1425
|
+
summary: "Show a webserver template from your account.",
|
|
1426
|
+
},
|
|
1427
|
+
{
|
|
1428
|
+
id: "webserver-templates.list-webserver-templates",
|
|
1429
|
+
method: "GET",
|
|
1430
|
+
path: "/api/webserver-templates",
|
|
1431
|
+
sourceUrl: "https://developers.ploi.io/webserver-templates/list-webserver-templates",
|
|
1432
|
+
summary: "List all webserver templates in your account.",
|
|
1433
|
+
},
|
|
1434
|
+
{
|
|
1435
|
+
id: "wordpress-management.activate-plugin",
|
|
1436
|
+
method: "POST",
|
|
1437
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/plugins/activate",
|
|
1438
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/activate-plugin",
|
|
1439
|
+
summary: "Activate a WordPress plugin on a site.",
|
|
1440
|
+
},
|
|
1441
|
+
{
|
|
1442
|
+
id: "wordpress-management.activate-theme",
|
|
1443
|
+
method: "POST",
|
|
1444
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/themes/activate",
|
|
1445
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/activate-theme",
|
|
1446
|
+
summary: "Activate a WordPress theme on a site.",
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
id: "wordpress-management.complete-install",
|
|
1450
|
+
method: "POST",
|
|
1451
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/complete-install",
|
|
1452
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/complete-install",
|
|
1453
|
+
summary: "Finish the WordPress installation on a freshly-installed site.",
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
id: "wordpress-management.deactivate-plugin",
|
|
1457
|
+
method: "POST",
|
|
1458
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/plugins/deactivate",
|
|
1459
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/deactivate-plugin",
|
|
1460
|
+
summary: "Deactivate a WordPress plugin on a site.",
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
id: "wordpress-management.delete-plugin",
|
|
1464
|
+
method: "DELETE",
|
|
1465
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/plugins/delete",
|
|
1466
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/delete-plugin",
|
|
1467
|
+
summary: "Uninstall and remove a WordPress plugin.",
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
id: "wordpress-management.delete-repository",
|
|
1471
|
+
method: "DELETE",
|
|
1472
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories/{repository}",
|
|
1473
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/delete-repository",
|
|
1474
|
+
summary: "Delete a sub-repository from a WordPress site.",
|
|
1475
|
+
},
|
|
1476
|
+
{
|
|
1477
|
+
id: "wordpress-management.delete-theme",
|
|
1478
|
+
method: "DELETE",
|
|
1479
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/themes/delete",
|
|
1480
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/delete-theme",
|
|
1481
|
+
summary: "Remove a WordPress theme.",
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
id: "wordpress-management.deploy-all-repositories",
|
|
1485
|
+
method: "POST",
|
|
1486
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories/deploy-all",
|
|
1487
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/deploy-all-repositories",
|
|
1488
|
+
summary: "Deploy all sub-repositories on a WordPress site.",
|
|
1489
|
+
},
|
|
1490
|
+
{
|
|
1491
|
+
id: "wordpress-management.deploy-repository",
|
|
1492
|
+
method: "POST",
|
|
1493
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories/{repository}/deploy",
|
|
1494
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/deploy-repository",
|
|
1495
|
+
summary: "Deploy a WordPress sub-repository.",
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
id: "wordpress-management.install-plugin",
|
|
1499
|
+
method: "POST",
|
|
1500
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/plugins/install",
|
|
1501
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/install-plugin",
|
|
1502
|
+
summary: "Install a WordPress plugin from the WordPress.org repository.",
|
|
1503
|
+
},
|
|
1504
|
+
{
|
|
1505
|
+
id: "wordpress-management.install-repository",
|
|
1506
|
+
method: "POST",
|
|
1507
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories",
|
|
1508
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/install-repository",
|
|
1509
|
+
summary: "Clone a Git repository into a subdirectory of a WordPress site.",
|
|
1510
|
+
},
|
|
1511
|
+
{
|
|
1512
|
+
id: "wordpress-management.install-theme",
|
|
1513
|
+
method: "POST",
|
|
1514
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/themes/install",
|
|
1515
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/install-theme",
|
|
1516
|
+
summary: "Install a WordPress theme from the WordPress.org repository.",
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
id: "wordpress-management.list-plugins",
|
|
1520
|
+
method: "GET",
|
|
1521
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/plugins",
|
|
1522
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/list-plugins",
|
|
1523
|
+
summary: "List all installed WordPress plugins on a site.",
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
id: "wordpress-management.list-repositories",
|
|
1527
|
+
method: "GET",
|
|
1528
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories",
|
|
1529
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/list-repositories",
|
|
1530
|
+
summary: "List all sub-repositories installed on a WordPress site.",
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
id: "wordpress-management.list-themes",
|
|
1534
|
+
method: "GET",
|
|
1535
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/themes",
|
|
1536
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/list-themes",
|
|
1537
|
+
summary: "List all installed WordPress themes on a site.",
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
id: "wordpress-management.run-wp-cli-command",
|
|
1541
|
+
method: "POST",
|
|
1542
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/wp-cli/run",
|
|
1543
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/run-wp-cli-command",
|
|
1544
|
+
summary: "Run an arbitrary WP-CLI command on a WordPress site.",
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
id: "wordpress-management.search-replace",
|
|
1548
|
+
method: "POST",
|
|
1549
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/search-replace",
|
|
1550
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/search-replace",
|
|
1551
|
+
summary: "Run a search-replace operation across the WordPress database.",
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
id: "wordpress-management.toggle-xmlrpc",
|
|
1555
|
+
method: "POST",
|
|
1556
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/toggle-xmlrpc",
|
|
1557
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/toggle-xmlrpc",
|
|
1558
|
+
summary: "Block or unblock XML-RPC access on a WordPress site.",
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
id: "wordpress-management.update-plugin",
|
|
1562
|
+
method: "POST",
|
|
1563
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/plugins/update",
|
|
1564
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/update-plugin",
|
|
1565
|
+
summary: "Update a WordPress plugin to the latest version.",
|
|
1566
|
+
},
|
|
1567
|
+
{
|
|
1568
|
+
id: "wordpress-management.update-repository",
|
|
1569
|
+
method: "PATCH",
|
|
1570
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories/{repository}",
|
|
1571
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/update-repository",
|
|
1572
|
+
summary: "Update the owner, name, or branch of a WordPress sub-repository.",
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
id: "wordpress-management.update-repository-deploy-script",
|
|
1576
|
+
method: "PATCH",
|
|
1577
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/repositories/{repository}/deploy-script",
|
|
1578
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/update-repository-deploy-script",
|
|
1579
|
+
summary: "Update the deploy script for a WordPress sub-repository.",
|
|
1580
|
+
},
|
|
1581
|
+
{
|
|
1582
|
+
id: "wordpress-management.update-theme",
|
|
1583
|
+
method: "POST",
|
|
1584
|
+
path: "/api/servers/{server}/sites/{site}/wordpress/themes/update",
|
|
1585
|
+
sourceUrl: "https://developers.ploi.io/wordpress-management/update-theme",
|
|
1586
|
+
summary: "Update a WordPress theme to the latest version.",
|
|
1587
|
+
},
|
|
1588
|
+
];
|
|
1589
|
+
|
|
1590
|
+
export const ploiCatalog = createPloiCatalog(PLOI_ENDPOINTS);
|