hostinger-api-mcp 0.1.37 → 0.1.40
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/.github/workflows/build-release.yaml +1 -0
- package/README.md +179 -740
- package/build.js +7 -2
- package/package.json +11 -5
- package/src/core/runtime.js +2106 -0
- package/src/core/runtime.ts +2137 -0
- package/{server.ts → src/core/tools/all.js} +238 -2267
- package/{server.js → src/core/tools/all.ts} +248 -2236
- package/src/core/tools/billing.js +163 -0
- package/src/core/tools/billing.ts +174 -0
- package/src/core/tools/dns.js +343 -0
- package/src/core/tools/dns.ts +354 -0
- package/src/core/tools/domains.js +533 -0
- package/src/core/tools/domains.ts +544 -0
- package/src/core/tools/hosting.js +448 -0
- package/src/core/tools/hosting.ts +459 -0
- package/src/core/tools/reach.js +349 -0
- package/src/core/tools/reach.ts +360 -0
- package/src/core/tools/vps.js +1816 -0
- package/src/core/tools/vps.ts +1827 -0
- package/src/servers/all.js +6 -0
- package/src/servers/all.ts +6 -0
- package/src/servers/billing.js +6 -0
- package/src/servers/billing.ts +6 -0
- package/src/servers/dns.js +6 -0
- package/src/servers/dns.ts +6 -0
- package/src/servers/domains.js +6 -0
- package/src/servers/domains.ts +6 -0
- package/src/servers/hosting.js +6 -0
- package/src/servers/hosting.ts +6 -0
- package/src/servers/reach.js +6 -0
- package/src/servers/reach.ts +6 -0
- package/src/servers/vps.js +6 -0
- package/src/servers/vps.ts +6 -0
- package/tsconfig.json +3 -2
package/README.md
CHANGED
|
@@ -45,6 +45,20 @@ yarn global upgrade hostinger-api-mcp
|
|
|
45
45
|
pnpm update -g hostinger-api-mcp
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
+
## Binaries
|
|
49
|
+
|
|
50
|
+
This package installs the following MCP server commands:
|
|
51
|
+
|
|
52
|
+
- `hostinger-api-mcp` — unified server with every tool (118 total)
|
|
53
|
+
- `hostinger-billing-mcp` — 7 tools for billing
|
|
54
|
+
- `hostinger-dns-mcp` — 8 tools for dns
|
|
55
|
+
- `hostinger-domains-mcp` — 18 tools for domains
|
|
56
|
+
- `hostinger-hosting-mcp` — 13 tools for hosting
|
|
57
|
+
- `hostinger-reach-mcp` — 10 tools for reach
|
|
58
|
+
- `hostinger-vps-mcp` — 62 tools for vps
|
|
59
|
+
|
|
60
|
+
Pick the binary that matches your agent's scope. `hostinger-api-mcp` remains the backwards-compatible default.
|
|
61
|
+
|
|
48
62
|
## Configuration
|
|
49
63
|
|
|
50
64
|
The following environment variables can be configured when running the server:
|
|
@@ -144,100 +158,9 @@ console.log("Tool result:", result);
|
|
|
144
158
|
|
|
145
159
|
This MCP server provides the following tools:
|
|
146
160
|
|
|
147
|
-
###
|
|
148
|
-
|
|
149
|
-
Import a WordPress website from an archive file to a hosting server. This tool uploads a website archive (zip, tar, tar.gz, etc.) and a database dump (.sql file) to deploy a complete WordPress website. The archive will be extracted on the server automatically. Note: This process may take a while for larger sites. After upload completion, files are being extracted and the site will be available in a few minutes. The username will be automatically resolved from the domain.
|
|
150
|
-
|
|
151
|
-
- **Method**: ``
|
|
152
|
-
- **Path**: ``
|
|
153
|
-
|
|
154
|
-
**Parameters**:
|
|
155
|
-
|
|
156
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
157
|
-
- `archivePath`: Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip) (required)
|
|
158
|
-
- `databaseDump`: Absolute or relative path to a database dump file (.sql) (required)
|
|
159
|
-
|
|
160
|
-
### hosting_deployWordpressPlugin
|
|
161
|
-
|
|
162
|
-
Deploy a WordPress plugin from a directory to a hosting server. This tool uploads all plugin files and triggers plugin deployment.
|
|
163
|
-
|
|
164
|
-
- **Method**: ``
|
|
165
|
-
- **Path**: ``
|
|
166
|
-
|
|
167
|
-
**Parameters**:
|
|
168
|
-
|
|
169
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
170
|
-
- `slug`: WordPress plugin slug (e.g., omnisend) (required)
|
|
171
|
-
- `pluginPath`: Absolute or relative path to the plugin directory containing all plugin files (required)
|
|
172
|
-
|
|
173
|
-
### hosting_deployWordpressTheme
|
|
174
|
-
|
|
175
|
-
Deploy a WordPress theme from a directory to a hosting server. This tool uploads all theme files and triggers theme deployment. The uploaded theme can optionally be activated after deployment.
|
|
176
|
-
|
|
177
|
-
- **Method**: ``
|
|
178
|
-
- **Path**: ``
|
|
179
|
-
|
|
180
|
-
**Parameters**:
|
|
181
|
-
|
|
182
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
183
|
-
- `slug`: WordPress theme slug (e.g., twentytwentyfive) (required)
|
|
184
|
-
- `themePath`: Absolute or relative path to the theme directory containing all theme files (required)
|
|
185
|
-
- `activate`: Whether to activate the theme after deployment (default: false)
|
|
186
|
-
|
|
187
|
-
### hosting_deployJsApplication
|
|
188
|
-
|
|
189
|
-
Deploy a JavaScript application from an archive file to a hosting server. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory; also exclude all files matched by .gitignore if the ignore file exists. The build process will be triggered automatically on the server after the archive is uploaded. After deployment, use the hosting_listJsDeployments tool to check deployment status and track build progress.
|
|
190
|
-
|
|
191
|
-
- **Method**: ``
|
|
192
|
-
- **Path**: ``
|
|
193
|
-
|
|
194
|
-
**Parameters**:
|
|
195
|
-
|
|
196
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
197
|
-
- `archivePath`: Absolute or relative path to the application archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory. (required)
|
|
198
|
-
- `removeArchive`: Whether to remove the archive file after successful deployment (default: false)
|
|
199
|
-
|
|
200
|
-
### hosting_deployStaticWebsite
|
|
201
|
-
|
|
202
|
-
Deploy a static website from an archive file to a hosting server. IMPORTANT: This tool only works for static websites with no build process. The archive must contain pre-built static files (HTML, CSS, JavaScript, images, etc.) ready to be served. If the website has a package.json file or requires a build command, use hosting_deployJsApplication instead. The archive will be extracted and deployed directly without any build steps. The username will be automatically resolved from the domain.
|
|
203
|
-
|
|
204
|
-
- **Method**: ``
|
|
205
|
-
- **Path**: ``
|
|
206
|
-
|
|
207
|
-
**Parameters**:
|
|
208
|
-
|
|
209
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
210
|
-
- `archivePath`: Absolute or relative path to the static website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mystaticwebsite_20250115_143022.zip) (required)
|
|
211
|
-
- `removeArchive`: Whether to remove the archive file after successful deployment (default: false)
|
|
212
|
-
|
|
213
|
-
### hosting_listJsDeployments
|
|
214
|
-
|
|
215
|
-
List javascript application deployments for checking their status. Use this tool when customer asks for the status of the deployment. This tool retrieves a paginated list of Node.js application deployments for a domain with optional filtering by deployment states.
|
|
216
|
-
|
|
217
|
-
- **Method**: ``
|
|
218
|
-
- **Path**: ``
|
|
219
|
-
|
|
220
|
-
**Parameters**:
|
|
221
|
-
|
|
222
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
223
|
-
- `page`: Page number for pagination (optional)
|
|
224
|
-
- `perPage`: Number of items per page (optional)
|
|
225
|
-
- `states`: Filter by deployment states (optional). Valid values: pending, completed, running, failed
|
|
226
|
-
|
|
227
|
-
### hosting_showJsDeploymentLogs
|
|
228
|
-
|
|
229
|
-
Retrieve logs for a specified JavaScript application deployment for debugging purposes in case of failure.
|
|
230
|
-
|
|
231
|
-
- **Method**: ``
|
|
232
|
-
- **Path**: ``
|
|
233
|
-
|
|
234
|
-
**Parameters**:
|
|
235
|
-
|
|
236
|
-
- `domain`: Domain name associated with the hosting account (e.g., example.com) (required)
|
|
237
|
-
- `fromLine`: Line from which to retrieve logs (optional, default 0)
|
|
238
|
-
- `buildUuid`: UUID of the JavaScript deployment build (required)
|
|
161
|
+
### `hostinger-billing-mcp`
|
|
239
162
|
|
|
240
|
-
|
|
163
|
+
#### billing_getCatalogItemListV1
|
|
241
164
|
|
|
242
165
|
Retrieve catalog items available for order.
|
|
243
166
|
|
|
@@ -249,12 +172,7 @@ Use this endpoint to view available services and pricing before placing orders.
|
|
|
249
172
|
- **Method**: `GET`
|
|
250
173
|
- **Path**: `/api/billing/v1/catalog`
|
|
251
174
|
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
- `category`: Filter catalog items by category
|
|
255
|
-
- `name`: Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain
|
|
256
|
-
|
|
257
|
-
### billing_setDefaultPaymentMethodV1
|
|
175
|
+
#### billing_setDefaultPaymentMethodV1
|
|
258
176
|
|
|
259
177
|
Set the default payment method for your account.
|
|
260
178
|
|
|
@@ -263,11 +181,7 @@ Use this endpoint to configure the primary payment method for future orders.
|
|
|
263
181
|
- **Method**: `POST`
|
|
264
182
|
- **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
|
|
265
183
|
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
- `paymentMethodId`: Payment method ID (required)
|
|
269
|
-
|
|
270
|
-
### billing_deletePaymentMethodV1
|
|
184
|
+
#### billing_deletePaymentMethodV1
|
|
271
185
|
|
|
272
186
|
Delete a payment method from your account.
|
|
273
187
|
|
|
@@ -276,11 +190,7 @@ Use this endpoint to remove unused payment methods from user accounts.
|
|
|
276
190
|
- **Method**: `DELETE`
|
|
277
191
|
- **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
|
|
278
192
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
- `paymentMethodId`: Payment method ID (required)
|
|
282
|
-
|
|
283
|
-
### billing_getPaymentMethodListV1
|
|
193
|
+
#### billing_getPaymentMethodListV1
|
|
284
194
|
|
|
285
195
|
Retrieve available payment methods that can be used for placing new orders.
|
|
286
196
|
|
|
@@ -292,9 +202,7 @@ Use this endpoint to view available payment options before creating orders.
|
|
|
292
202
|
- **Method**: `GET`
|
|
293
203
|
- **Path**: `/api/billing/v1/payment-methods`
|
|
294
204
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
### billing_getSubscriptionListV1
|
|
205
|
+
#### billing_getSubscriptionListV1
|
|
298
206
|
|
|
299
207
|
Retrieve a list of all subscriptions associated with your account.
|
|
300
208
|
|
|
@@ -303,9 +211,7 @@ Use this endpoint to monitor active services and billing status.
|
|
|
303
211
|
- **Method**: `GET`
|
|
304
212
|
- **Path**: `/api/billing/v1/subscriptions`
|
|
305
213
|
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
### billing_disableAutoRenewalV1
|
|
214
|
+
#### billing_disableAutoRenewalV1
|
|
309
215
|
|
|
310
216
|
Disable auto-renewal for a subscription.
|
|
311
217
|
|
|
@@ -314,11 +220,7 @@ Use this endpoint when disable auto-renewal for a subscription.
|
|
|
314
220
|
- **Method**: `DELETE`
|
|
315
221
|
- **Path**: `/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable`
|
|
316
222
|
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
- `subscriptionId`: Subscription ID (required)
|
|
320
|
-
|
|
321
|
-
### billing_enableAutoRenewalV1
|
|
223
|
+
#### billing_enableAutoRenewalV1
|
|
322
224
|
|
|
323
225
|
Enable auto-renewal for a subscription.
|
|
324
226
|
|
|
@@ -327,11 +229,9 @@ Use this endpoint when enable auto-renewal for a subscription.
|
|
|
327
229
|
- **Method**: `PATCH`
|
|
328
230
|
- **Path**: `/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable`
|
|
329
231
|
|
|
330
|
-
|
|
232
|
+
### `hostinger-dns-mcp`
|
|
331
233
|
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
### DNS_getDNSSnapshotV1
|
|
234
|
+
#### DNS_getDNSSnapshotV1
|
|
335
235
|
|
|
336
236
|
Retrieve particular DNS snapshot with contents of DNS zone records.
|
|
337
237
|
|
|
@@ -340,12 +240,7 @@ Use this endpoint to view historical DNS configurations for domains.
|
|
|
340
240
|
- **Method**: `GET`
|
|
341
241
|
- **Path**: `/api/dns/v1/snapshots/{domain}/{snapshotId}`
|
|
342
242
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
- `domain`: Domain name (required)
|
|
346
|
-
- `snapshotId`: Snapshot ID (required)
|
|
347
|
-
|
|
348
|
-
### DNS_getDNSSnapshotListV1
|
|
243
|
+
#### DNS_getDNSSnapshotListV1
|
|
349
244
|
|
|
350
245
|
Retrieve DNS snapshots for a domain.
|
|
351
246
|
|
|
@@ -354,11 +249,7 @@ Use this endpoint to view available DNS backup points for restoration.
|
|
|
354
249
|
- **Method**: `GET`
|
|
355
250
|
- **Path**: `/api/dns/v1/snapshots/{domain}`
|
|
356
251
|
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
- `domain`: Domain name (required)
|
|
360
|
-
|
|
361
|
-
### DNS_restoreDNSSnapshotV1
|
|
252
|
+
#### DNS_restoreDNSSnapshotV1
|
|
362
253
|
|
|
363
254
|
Restore DNS zone to the selected snapshot.
|
|
364
255
|
|
|
@@ -367,12 +258,7 @@ Use this endpoint to revert domain DNS to a previous configuration.
|
|
|
367
258
|
- **Method**: `POST`
|
|
368
259
|
- **Path**: `/api/dns/v1/snapshots/{domain}/{snapshotId}/restore`
|
|
369
260
|
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
- `domain`: Domain name (required)
|
|
373
|
-
- `snapshotId`: Snapshot ID (required)
|
|
374
|
-
|
|
375
|
-
### DNS_getDNSRecordsV1
|
|
261
|
+
#### DNS_getDNSRecordsV1
|
|
376
262
|
|
|
377
263
|
Retrieve DNS zone records for a specific domain.
|
|
378
264
|
|
|
@@ -381,11 +267,7 @@ Use this endpoint to view current DNS configuration for domain management.
|
|
|
381
267
|
- **Method**: `GET`
|
|
382
268
|
- **Path**: `/api/dns/v1/zones/{domain}`
|
|
383
269
|
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
- `domain`: Domain name (required)
|
|
387
|
-
|
|
388
|
-
### DNS_updateDNSRecordsV1
|
|
270
|
+
#### DNS_updateDNSRecordsV1
|
|
389
271
|
|
|
390
272
|
Update DNS records for the selected domain.
|
|
391
273
|
|
|
@@ -397,15 +279,7 @@ Use this endpoint to modify domain DNS configuration.
|
|
|
397
279
|
- **Method**: `PUT`
|
|
398
280
|
- **Path**: `/api/dns/v1/zones/{domain}`
|
|
399
281
|
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
- `domain`: Domain name (required)
|
|
403
|
-
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
404
|
-
otherwise resource records' ttl's are updated and new records are appended.
|
|
405
|
-
If no matching RRs are found, they are created.
|
|
406
|
-
- `zone`: zone parameter (required)
|
|
407
|
-
|
|
408
|
-
### DNS_deleteDNSRecordsV1
|
|
282
|
+
#### DNS_deleteDNSRecordsV1
|
|
409
283
|
|
|
410
284
|
Delete DNS records for the selected domain.
|
|
411
285
|
|
|
@@ -420,11 +294,7 @@ Use this endpoint to remove specific DNS records from domains.
|
|
|
420
294
|
- **Method**: `DELETE`
|
|
421
295
|
- **Path**: `/api/dns/v1/zones/{domain}`
|
|
422
296
|
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
- `domain`: Domain name (required)
|
|
426
|
-
|
|
427
|
-
### DNS_resetDNSRecordsV1
|
|
297
|
+
#### DNS_resetDNSRecordsV1
|
|
428
298
|
|
|
429
299
|
Reset DNS zone to the default records.
|
|
430
300
|
|
|
@@ -433,14 +303,7 @@ Use this endpoint to restore domain DNS to original configuration.
|
|
|
433
303
|
- **Method**: `POST`
|
|
434
304
|
- **Path**: `/api/dns/v1/zones/{domain}/reset`
|
|
435
305
|
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
- `domain`: Domain name (required)
|
|
439
|
-
- `sync`: Determines if operation should be run synchronously
|
|
440
|
-
- `reset_email_records`: Determines if email records should be reset
|
|
441
|
-
- `whitelisted_record_types`: Specifies which record types to not reset
|
|
442
|
-
|
|
443
|
-
### DNS_validateDNSRecordsV1
|
|
306
|
+
#### DNS_validateDNSRecordsV1
|
|
444
307
|
|
|
445
308
|
Validate DNS records prior to update for the selected domain.
|
|
446
309
|
|
|
@@ -452,24 +315,16 @@ Use this endpoint to verify DNS record validity before applying changes.
|
|
|
452
315
|
- **Method**: `POST`
|
|
453
316
|
- **Path**: `/api/dns/v1/zones/{domain}/validate`
|
|
454
317
|
|
|
455
|
-
|
|
318
|
+
### `hostinger-domains-mcp`
|
|
456
319
|
|
|
457
|
-
|
|
458
|
-
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
459
|
-
otherwise resource records' ttl's are updated and new records are appended.
|
|
460
|
-
If no matching RRs are found, they are created.
|
|
461
|
-
- `zone`: zone parameter (required)
|
|
462
|
-
|
|
463
|
-
### v2_getDomainVerificationsDIRECT
|
|
320
|
+
#### v2_getDomainVerificationsDIRECT
|
|
464
321
|
|
|
465
322
|
Retrieve a list of pending and completed domain verifications.
|
|
466
323
|
|
|
467
324
|
- **Method**: `GET`
|
|
468
325
|
- **Path**: `/api/v2/direct/verifications/active`
|
|
469
326
|
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
### domains_checkDomainAvailabilityV1
|
|
327
|
+
#### domains_checkDomainAvailabilityV1
|
|
473
328
|
|
|
474
329
|
Check availability of domain names across multiple TLDs.
|
|
475
330
|
|
|
@@ -484,13 +339,7 @@ Use this endpoint to verify domain availability before purchase.
|
|
|
484
339
|
- **Method**: `POST`
|
|
485
340
|
- **Path**: `/api/domains/v1/availability`
|
|
486
341
|
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
- `domain`: Domain name (without TLD) (required)
|
|
490
|
-
- `tlds`: TLDs list (required)
|
|
491
|
-
- `with_alternatives`: Should response include alternatives
|
|
492
|
-
|
|
493
|
-
### domains_getDomainForwardingV1
|
|
342
|
+
#### domains_getDomainForwardingV1
|
|
494
343
|
|
|
495
344
|
Retrieve domain forwarding data.
|
|
496
345
|
|
|
@@ -499,11 +348,7 @@ Use this endpoint to view current redirect configuration for domains.
|
|
|
499
348
|
- **Method**: `GET`
|
|
500
349
|
- **Path**: `/api/domains/v1/forwarding/{domain}`
|
|
501
350
|
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
- `domain`: Domain name (required)
|
|
505
|
-
|
|
506
|
-
### domains_deleteDomainForwardingV1
|
|
351
|
+
#### domains_deleteDomainForwardingV1
|
|
507
352
|
|
|
508
353
|
Delete domain forwarding data.
|
|
509
354
|
|
|
@@ -512,11 +357,7 @@ Use this endpoint to remove redirect configuration from domains.
|
|
|
512
357
|
- **Method**: `DELETE`
|
|
513
358
|
- **Path**: `/api/domains/v1/forwarding/{domain}`
|
|
514
359
|
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
- `domain`: Domain name (required)
|
|
518
|
-
|
|
519
|
-
### domains_createDomainForwardingV1
|
|
360
|
+
#### domains_createDomainForwardingV1
|
|
520
361
|
|
|
521
362
|
Create domain forwarding configuration.
|
|
522
363
|
|
|
@@ -525,13 +366,7 @@ Use this endpoint to set up domain redirects to other URLs.
|
|
|
525
366
|
- **Method**: `POST`
|
|
526
367
|
- **Path**: `/api/domains/v1/forwarding`
|
|
527
368
|
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
- `domain`: Domain name (required)
|
|
531
|
-
- `redirect_type`: Redirect type (required)
|
|
532
|
-
- `redirect_url`: URL to forward domain to (required)
|
|
533
|
-
|
|
534
|
-
### domains_enableDomainLockV1
|
|
369
|
+
#### domains_enableDomainLockV1
|
|
535
370
|
|
|
536
371
|
Enable domain lock for the domain.
|
|
537
372
|
|
|
@@ -543,11 +378,7 @@ Use this endpoint to secure domains against unauthorized transfers.
|
|
|
543
378
|
- **Method**: `PUT`
|
|
544
379
|
- **Path**: `/api/domains/v1/portfolio/{domain}/domain-lock`
|
|
545
380
|
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
- `domain`: Domain name (required)
|
|
549
|
-
|
|
550
|
-
### domains_disableDomainLockV1
|
|
381
|
+
#### domains_disableDomainLockV1
|
|
551
382
|
|
|
552
383
|
Disable domain lock for the domain.
|
|
553
384
|
|
|
@@ -558,11 +389,7 @@ Use this endpoint to prepare domains for transfer to other registrars.
|
|
|
558
389
|
- **Method**: `DELETE`
|
|
559
390
|
- **Path**: `/api/domains/v1/portfolio/{domain}/domain-lock`
|
|
560
391
|
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
- `domain`: Domain name (required)
|
|
564
|
-
|
|
565
|
-
### domains_getDomainDetailsV1
|
|
392
|
+
#### domains_getDomainDetailsV1
|
|
566
393
|
|
|
567
394
|
Retrieve detailed information for specified domain.
|
|
568
395
|
|
|
@@ -571,11 +398,7 @@ Use this endpoint to view comprehensive domain configuration and status.
|
|
|
571
398
|
- **Method**: `GET`
|
|
572
399
|
- **Path**: `/api/domains/v1/portfolio/{domain}`
|
|
573
400
|
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
- `domain`: Domain name (required)
|
|
577
|
-
|
|
578
|
-
### domains_getDomainListV1
|
|
401
|
+
#### domains_getDomainListV1
|
|
579
402
|
|
|
580
403
|
Retrieve all domains associated with your account.
|
|
581
404
|
|
|
@@ -584,9 +407,7 @@ Use this endpoint to view user's domain portfolio.
|
|
|
584
407
|
- **Method**: `GET`
|
|
585
408
|
- **Path**: `/api/domains/v1/portfolio`
|
|
586
409
|
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
### domains_purchaseNewDomainV1
|
|
410
|
+
#### domains_purchaseNewDomainV1
|
|
590
411
|
|
|
591
412
|
Purchase and register a new domain name.
|
|
592
413
|
|
|
@@ -604,16 +425,7 @@ Use this endpoint to register new domains for users.
|
|
|
604
425
|
- **Method**: `POST`
|
|
605
426
|
- **Path**: `/api/domains/v1/portfolio`
|
|
606
427
|
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
- `domain`: Domain name (required)
|
|
610
|
-
- `item_id`: Catalog price item ID (required)
|
|
611
|
-
- `payment_method_id`: Payment method ID, default will be used if not provided
|
|
612
|
-
- `domain_contacts`: Domain contact information
|
|
613
|
-
- `additional_details`: Additional registration data, possible values depends on TLD
|
|
614
|
-
- `coupons`: Discount coupon codes
|
|
615
|
-
|
|
616
|
-
### domains_enablePrivacyProtectionV1
|
|
428
|
+
#### domains_enablePrivacyProtectionV1
|
|
617
429
|
|
|
618
430
|
Enable privacy protection for the domain.
|
|
619
431
|
|
|
@@ -624,11 +436,7 @@ Use this endpoint to protect domain owner's personal information from public vie
|
|
|
624
436
|
- **Method**: `PUT`
|
|
625
437
|
- **Path**: `/api/domains/v1/portfolio/{domain}/privacy-protection`
|
|
626
438
|
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
- `domain`: Domain name (required)
|
|
630
|
-
|
|
631
|
-
### domains_disablePrivacyProtectionV1
|
|
439
|
+
#### domains_disablePrivacyProtectionV1
|
|
632
440
|
|
|
633
441
|
Disable privacy protection for the domain.
|
|
634
442
|
|
|
@@ -639,11 +447,7 @@ Use this endpoint to make domain owner's information publicly visible.
|
|
|
639
447
|
- **Method**: `DELETE`
|
|
640
448
|
- **Path**: `/api/domains/v1/portfolio/{domain}/privacy-protection`
|
|
641
449
|
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
- `domain`: Domain name (required)
|
|
645
|
-
|
|
646
|
-
### domains_updateDomainNameserversV1
|
|
450
|
+
#### domains_updateDomainNameserversV1
|
|
647
451
|
|
|
648
452
|
Set nameservers for a specified domain.
|
|
649
453
|
|
|
@@ -654,15 +458,7 @@ Use this endpoint to configure custom DNS hosting for domains.
|
|
|
654
458
|
- **Method**: `PUT`
|
|
655
459
|
- **Path**: `/api/domains/v1/portfolio/{domain}/nameservers`
|
|
656
460
|
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
- `domain`: Domain name (required)
|
|
660
|
-
- `ns1`: First name server (required)
|
|
661
|
-
- `ns2`: Second name server (required)
|
|
662
|
-
- `ns3`: Third name server
|
|
663
|
-
- `ns4`: Fourth name server
|
|
664
|
-
|
|
665
|
-
### domains_getWHOISProfileV1
|
|
461
|
+
#### domains_getWHOISProfileV1
|
|
666
462
|
|
|
667
463
|
Retrieve a WHOIS contact profile.
|
|
668
464
|
|
|
@@ -671,11 +467,7 @@ Use this endpoint to view domain registration contact information.
|
|
|
671
467
|
- **Method**: `GET`
|
|
672
468
|
- **Path**: `/api/domains/v1/whois/{whoisId}`
|
|
673
469
|
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
- `whoisId`: WHOIS ID (required)
|
|
677
|
-
|
|
678
|
-
### domains_deleteWHOISProfileV1
|
|
470
|
+
#### domains_deleteWHOISProfileV1
|
|
679
471
|
|
|
680
472
|
Delete WHOIS contact profile.
|
|
681
473
|
|
|
@@ -684,11 +476,7 @@ Use this endpoint to remove unused contact profiles from account.
|
|
|
684
476
|
- **Method**: `DELETE`
|
|
685
477
|
- **Path**: `/api/domains/v1/whois/{whoisId}`
|
|
686
478
|
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
- `whoisId`: WHOIS ID (required)
|
|
690
|
-
|
|
691
|
-
### domains_getWHOISProfileListV1
|
|
479
|
+
#### domains_getWHOISProfileListV1
|
|
692
480
|
|
|
693
481
|
Retrieve WHOIS contact profiles.
|
|
694
482
|
|
|
@@ -697,11 +485,7 @@ Use this endpoint to view available contact profiles for domain registration.
|
|
|
697
485
|
- **Method**: `GET`
|
|
698
486
|
- **Path**: `/api/domains/v1/whois`
|
|
699
487
|
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
- `tld`: Filter by TLD (without leading dot)
|
|
703
|
-
|
|
704
|
-
### domains_createWHOISProfileV1
|
|
488
|
+
#### domains_createWHOISProfileV1
|
|
705
489
|
|
|
706
490
|
Create WHOIS contact profile.
|
|
707
491
|
|
|
@@ -710,15 +494,7 @@ Use this endpoint to add new contact information for domain registration.
|
|
|
710
494
|
- **Method**: `POST`
|
|
711
495
|
- **Path**: `/api/domains/v1/whois`
|
|
712
496
|
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
- `tld`: TLD of the domain (without leading dot) (required)
|
|
716
|
-
- `country`: ISO 3166 2-letter country code (required)
|
|
717
|
-
- `entity_type`: Legal entity type (required)
|
|
718
|
-
- `tld_details`: TLD details
|
|
719
|
-
- `whois_details`: WHOIS details (required)
|
|
720
|
-
|
|
721
|
-
### domains_getWHOISProfileUsageV1
|
|
497
|
+
#### domains_getWHOISProfileUsageV1
|
|
722
498
|
|
|
723
499
|
Retrieve domain list where provided WHOIS contact profile is used.
|
|
724
500
|
|
|
@@ -727,11 +503,58 @@ Use this endpoint to view which domains use specific contact profiles.
|
|
|
727
503
|
- **Method**: `GET`
|
|
728
504
|
- **Path**: `/api/domains/v1/whois/{whoisId}/usage`
|
|
729
505
|
|
|
730
|
-
|
|
506
|
+
### `hostinger-hosting-mcp`
|
|
507
|
+
|
|
508
|
+
#### hosting_importWordpressWebsite
|
|
731
509
|
|
|
732
|
-
|
|
510
|
+
Import a WordPress website from an archive file to a hosting server. This tool uploads a website archive (zip, tar, tar.gz, etc.) and a database dump (.sql file) to deploy a complete WordPress website. The archive will be extracted on the server automatically. Note: This process may take a while for larger sites. After upload completion, files are being extracted and the site will be available in a few minutes. The username will be automatically resolved from the domain.
|
|
511
|
+
|
|
512
|
+
- **Method**: `custom`
|
|
513
|
+
- **Path**: `custom`
|
|
514
|
+
|
|
515
|
+
#### hosting_deployWordpressPlugin
|
|
516
|
+
|
|
517
|
+
Deploy a WordPress plugin from a directory to a hosting server. This tool uploads all plugin files and triggers plugin deployment.
|
|
518
|
+
|
|
519
|
+
- **Method**: `custom`
|
|
520
|
+
- **Path**: `custom`
|
|
521
|
+
|
|
522
|
+
#### hosting_deployWordpressTheme
|
|
523
|
+
|
|
524
|
+
Deploy a WordPress theme from a directory to a hosting server. This tool uploads all theme files and triggers theme deployment. The uploaded theme can optionally be activated after deployment.
|
|
525
|
+
|
|
526
|
+
- **Method**: `custom`
|
|
527
|
+
- **Path**: `custom`
|
|
528
|
+
|
|
529
|
+
#### hosting_deployJsApplication
|
|
530
|
+
|
|
531
|
+
Deploy a JavaScript application from an archive file to a hosting server. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory; also exclude all files matched by .gitignore if the ignore file exists. The build process will be triggered automatically on the server after the archive is uploaded. After deployment, use the hosting_listJsDeployments tool to check deployment status and track build progress.
|
|
532
|
+
|
|
533
|
+
- **Method**: `custom`
|
|
534
|
+
- **Path**: `custom`
|
|
535
|
+
|
|
536
|
+
#### hosting_deployStaticWebsite
|
|
537
|
+
|
|
538
|
+
Deploy a static website from an archive file to a hosting server. IMPORTANT: This tool only works for static websites with no build process. The archive must contain pre-built static files (HTML, CSS, JavaScript, images, etc.) ready to be served. If the website has a package.json file or requires a build command, use hosting_deployJsApplication instead. The archive will be extracted and deployed directly without any build steps. The username will be automatically resolved from the domain.
|
|
539
|
+
|
|
540
|
+
- **Method**: `custom`
|
|
541
|
+
- **Path**: `custom`
|
|
733
542
|
|
|
734
|
-
|
|
543
|
+
#### hosting_listJsDeployments
|
|
544
|
+
|
|
545
|
+
List javascript application deployments for checking their status. Use this tool when customer asks for the status of the deployment. This tool retrieves a paginated list of Node.js application deployments for a domain with optional filtering by deployment states.
|
|
546
|
+
|
|
547
|
+
- **Method**: `custom`
|
|
548
|
+
- **Path**: `custom`
|
|
549
|
+
|
|
550
|
+
#### hosting_showJsDeploymentLogs
|
|
551
|
+
|
|
552
|
+
Retrieve logs for a specified JavaScript application deployment for debugging purposes in case of failure.
|
|
553
|
+
|
|
554
|
+
- **Method**: `custom`
|
|
555
|
+
- **Path**: `custom`
|
|
556
|
+
|
|
557
|
+
#### hosting_listAvailableDatacentersV1
|
|
735
558
|
|
|
736
559
|
Retrieve a list of datacenters available for setting up hosting plans
|
|
737
560
|
based on available datacenter capacity and hosting plan of your order.
|
|
@@ -741,11 +564,7 @@ requirements.
|
|
|
741
564
|
- **Method**: `GET`
|
|
742
565
|
- **Path**: `/api/hosting/v1/datacenters`
|
|
743
566
|
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
- `order_id`: Order ID (required)
|
|
747
|
-
|
|
748
|
-
### hosting_generateAFreeSubdomainV1
|
|
567
|
+
#### hosting_generateAFreeSubdomainV1
|
|
749
568
|
|
|
750
569
|
Generate a unique free subdomain that can be used for hosting services without purchasing custom domains.
|
|
751
570
|
Free subdomains allow you to start using hosting services immediately
|
|
@@ -754,9 +573,7 @@ and you can always connect a custom domain to your site later.
|
|
|
754
573
|
- **Method**: `POST`
|
|
755
574
|
- **Path**: `/api/hosting/v1/domains/free-subdomains`
|
|
756
575
|
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
### hosting_verifyDomainOwnershipV1
|
|
576
|
+
#### hosting_verifyDomainOwnershipV1
|
|
760
577
|
|
|
761
578
|
Verify ownership of a single domain and return the verification status.
|
|
762
579
|
|
|
@@ -770,11 +587,7 @@ Skip this verification when using Hostinger's free subdomains (*.hostingersite.c
|
|
|
770
587
|
- **Method**: `POST`
|
|
771
588
|
- **Path**: `/api/hosting/v1/domains/verify-ownership`
|
|
772
589
|
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
- `domain`: Domain to verify ownership for (required)
|
|
776
|
-
|
|
777
|
-
### hosting_listOrdersV1
|
|
590
|
+
#### hosting_listOrdersV1
|
|
778
591
|
|
|
779
592
|
Retrieve a paginated list of orders accessible to the authenticated client.
|
|
780
593
|
|
|
@@ -787,14 +600,7 @@ or specific order IDs for more targeted results.
|
|
|
787
600
|
- **Method**: `GET`
|
|
788
601
|
- **Path**: `/api/hosting/v1/orders`
|
|
789
602
|
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
- `page`: Page number
|
|
793
|
-
- `per_page`: Number of items per page
|
|
794
|
-
- `statuses`: Filter by order statuses
|
|
795
|
-
- `order_ids`: Filter by specific order IDs
|
|
796
|
-
|
|
797
|
-
### hosting_listWebsitesV1
|
|
603
|
+
#### hosting_listWebsitesV1
|
|
798
604
|
|
|
799
605
|
Retrieve a paginated list of websites (main and addon types) accessible to the authenticated client.
|
|
800
606
|
|
|
@@ -808,16 +614,7 @@ order ID, enabled status, or domain name for more targeted results.
|
|
|
808
614
|
- **Method**: `GET`
|
|
809
615
|
- **Path**: `/api/hosting/v1/websites`
|
|
810
616
|
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
- `page`: Page number
|
|
814
|
-
- `per_page`: Number of items per page
|
|
815
|
-
- `username`: Filter by specific username
|
|
816
|
-
- `order_id`: Order ID
|
|
817
|
-
- `is_enabled`: Filter by enabled status
|
|
818
|
-
- `domain`: Filter by domain name (exact match)
|
|
819
|
-
|
|
820
|
-
### hosting_createWebsiteV1
|
|
617
|
+
#### hosting_createWebsiteV1
|
|
821
618
|
|
|
822
619
|
Create a new website for the authenticated client.
|
|
823
620
|
|
|
@@ -834,13 +631,9 @@ websites list endpoint to see when your new website becomes available.
|
|
|
834
631
|
- **Method**: `POST`
|
|
835
632
|
- **Path**: `/api/hosting/v1/websites`
|
|
836
633
|
|
|
837
|
-
|
|
634
|
+
### `hostinger-reach-mcp`
|
|
838
635
|
|
|
839
|
-
|
|
840
|
-
- `order_id`: ID of the associated order (required)
|
|
841
|
-
- `datacenter_code`: Datacenter code. This parameter is required when creating the first website on a new hosting plan.
|
|
842
|
-
|
|
843
|
-
### reach_deleteAContactV1
|
|
636
|
+
#### reach_deleteAContactV1
|
|
844
637
|
|
|
845
638
|
Delete a contact with the specified UUID.
|
|
846
639
|
|
|
@@ -849,11 +642,7 @@ This endpoint permanently removes a contact from the email marketing system.
|
|
|
849
642
|
- **Method**: `DELETE`
|
|
850
643
|
- **Path**: `/api/reach/v1/contacts/{uuid}`
|
|
851
644
|
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
- `uuid`: UUID of the contact to delete (required)
|
|
855
|
-
|
|
856
|
-
### reach_listContactGroupsV1
|
|
645
|
+
#### reach_listContactGroupsV1
|
|
857
646
|
|
|
858
647
|
Get a list of all contact groups.
|
|
859
648
|
|
|
@@ -862,9 +651,7 @@ This endpoint returns a list of contact groups that can be used to organize cont
|
|
|
862
651
|
- **Method**: `GET`
|
|
863
652
|
- **Path**: `/api/reach/v1/contacts/groups`
|
|
864
653
|
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
### reach_listContactsV1
|
|
654
|
+
#### reach_listContactsV1
|
|
868
655
|
|
|
869
656
|
Get a list of contacts, optionally filtered by group and subscription status.
|
|
870
657
|
|
|
@@ -874,13 +661,7 @@ You can filter contacts by group UUID and subscription status.
|
|
|
874
661
|
- **Method**: `GET`
|
|
875
662
|
- **Path**: `/api/reach/v1/contacts`
|
|
876
663
|
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
- `group_uuid`: Filter contacts by group UUID
|
|
880
|
-
- `subscription_status`: Filter contacts by subscription status
|
|
881
|
-
- `page`: Page number
|
|
882
|
-
|
|
883
|
-
### reach_createANewContactV1
|
|
664
|
+
#### reach_createANewContactV1
|
|
884
665
|
|
|
885
666
|
Create a new contact in the email marketing system.
|
|
886
667
|
|
|
@@ -892,14 +673,7 @@ the contact will be created with a pending status and a confirmation email will
|
|
|
892
673
|
- **Method**: `POST`
|
|
893
674
|
- **Path**: `/api/reach/v1/contacts`
|
|
894
675
|
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
- `email`: email parameter (required)
|
|
898
|
-
- `name`: name parameter
|
|
899
|
-
- `surname`: surname parameter
|
|
900
|
-
- `note`: note parameter
|
|
901
|
-
|
|
902
|
-
### reach_listSegmentsV1
|
|
676
|
+
#### reach_listSegmentsV1
|
|
903
677
|
|
|
904
678
|
Get a list of all contact segments.
|
|
905
679
|
|
|
@@ -908,9 +682,7 @@ This endpoint returns a list of contact segments that can be used to organize co
|
|
|
908
682
|
- **Method**: `GET`
|
|
909
683
|
- **Path**: `/api/reach/v1/segmentation/segments`
|
|
910
684
|
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
### reach_createANewContactSegmentV1
|
|
685
|
+
#### reach_createANewContactSegmentV1
|
|
914
686
|
|
|
915
687
|
Create a new contact segment.
|
|
916
688
|
|
|
@@ -920,13 +692,7 @@ The segment can be configured with specific criteria like email, name, subscript
|
|
|
920
692
|
- **Method**: `POST`
|
|
921
693
|
- **Path**: `/api/reach/v1/segmentation/segments`
|
|
922
694
|
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
- `name`: name parameter (required)
|
|
926
|
-
- `conditions`: conditions parameter (required)
|
|
927
|
-
- `logic`: logic parameter (required)
|
|
928
|
-
|
|
929
|
-
### reach_listSegmentContactsV1
|
|
695
|
+
#### reach_listSegmentContactsV1
|
|
930
696
|
|
|
931
697
|
Retrieve contacts associated with a specific segment.
|
|
932
698
|
|
|
@@ -936,13 +702,7 @@ identified by its UUID.
|
|
|
936
702
|
- **Method**: `GET`
|
|
937
703
|
- **Path**: `/api/reach/v1/segmentation/segments/{segmentUuid}/contacts`
|
|
938
704
|
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
- `segmentUuid`: Segment uuid parameter (required)
|
|
942
|
-
- `page`: Page number
|
|
943
|
-
- `per_page`: Number of items per page
|
|
944
|
-
|
|
945
|
-
### reach_getSegmentDetailsV1
|
|
705
|
+
#### reach_getSegmentDetailsV1
|
|
946
706
|
|
|
947
707
|
Get details of a specific segment.
|
|
948
708
|
|
|
@@ -952,11 +712,7 @@ Segments are used to organize and group contacts based on specific criteria.
|
|
|
952
712
|
- **Method**: `GET`
|
|
953
713
|
- **Path**: `/api/reach/v1/segmentation/segments/{segmentUuid}`
|
|
954
714
|
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
- `segmentUuid`: Segment uuid parameter (required)
|
|
958
|
-
|
|
959
|
-
### reach_createNewContactsV1
|
|
715
|
+
#### reach_createNewContactsV1
|
|
960
716
|
|
|
961
717
|
Create a new contact in the email marketing system.
|
|
962
718
|
|
|
@@ -968,24 +724,16 @@ and a confirmation email will be sent.
|
|
|
968
724
|
- **Method**: `POST`
|
|
969
725
|
- **Path**: `/api/reach/v1/profiles/{profileUuid}/contacts`
|
|
970
726
|
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
- `profileUuid`: Profile uuid parameter (required)
|
|
974
|
-
- `email`: email parameter (required)
|
|
975
|
-
- `name`: name parameter
|
|
976
|
-
- `surname`: surname parameter
|
|
977
|
-
- `note`: note parameter
|
|
978
|
-
|
|
979
|
-
### reach_listProfilesV1
|
|
727
|
+
#### reach_listProfilesV1
|
|
980
728
|
|
|
981
729
|
This endpoint returns all profiles available to the client, including their basic information.
|
|
982
730
|
|
|
983
731
|
- **Method**: `GET`
|
|
984
732
|
- **Path**: `/api/reach/v1/profiles`
|
|
985
733
|
|
|
734
|
+
### `hostinger-vps-mcp`
|
|
986
735
|
|
|
987
|
-
|
|
988
|
-
### VPS_getDataCenterListV1
|
|
736
|
+
#### VPS_getDataCenterListV1
|
|
989
737
|
|
|
990
738
|
Retrieve all available data centers.
|
|
991
739
|
|
|
@@ -994,9 +742,7 @@ Use this endpoint to view location options before deploying VPS instances.
|
|
|
994
742
|
- **Method**: `GET`
|
|
995
743
|
- **Path**: `/api/vps/v1/data-centers`
|
|
996
744
|
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
### VPS_getProjectContainersV1
|
|
745
|
+
#### VPS_getProjectContainersV1
|
|
1000
746
|
|
|
1001
747
|
Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine.
|
|
1002
748
|
|
|
@@ -1008,12 +754,7 @@ Use this to monitor the health and state of all services within your Docker Comp
|
|
|
1008
754
|
- **Method**: `GET`
|
|
1009
755
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers`
|
|
1010
756
|
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1014
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1015
|
-
|
|
1016
|
-
### VPS_getProjectContentsV1
|
|
757
|
+
#### VPS_getProjectContentsV1
|
|
1017
758
|
|
|
1018
759
|
Retrieves the complete project information including the docker-compose.yml
|
|
1019
760
|
file contents, project metadata, and current deployment status.
|
|
@@ -1025,12 +766,7 @@ Use this to inspect project settings, review the compose file, or check the over
|
|
|
1025
766
|
- **Method**: `GET`
|
|
1026
767
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}`
|
|
1027
768
|
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1031
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1032
|
-
|
|
1033
|
-
### VPS_deleteProjectV1
|
|
769
|
+
#### VPS_deleteProjectV1
|
|
1034
770
|
|
|
1035
771
|
Completely removes a Docker Compose project from the virtual machine, stopping all containers and cleaning up
|
|
1036
772
|
associated resources including networks, volumes, and images.
|
|
@@ -1042,12 +778,7 @@ Use this when you want to permanently remove a project and free up system resour
|
|
|
1042
778
|
- **Method**: `DELETE`
|
|
1043
779
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down`
|
|
1044
780
|
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1048
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1049
|
-
|
|
1050
|
-
### VPS_getProjectListV1
|
|
781
|
+
#### VPS_getProjectListV1
|
|
1051
782
|
|
|
1052
783
|
Retrieves a list of all Docker Compose projects currently deployed on the virtual machine.
|
|
1053
784
|
|
|
@@ -1062,11 +793,7 @@ Use this to get an overview of all Docker projects on your VPS instance.
|
|
|
1062
793
|
- **Method**: `GET`
|
|
1063
794
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker`
|
|
1064
795
|
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1068
|
-
|
|
1069
|
-
### VPS_createNewProjectV1
|
|
796
|
+
#### VPS_createNewProjectV1
|
|
1070
797
|
|
|
1071
798
|
Deploy new project from docker-compose.yaml contents or download contents from URL.
|
|
1072
799
|
|
|
@@ -1080,14 +807,7 @@ If project with the same name already exists, existing project will be replaced.
|
|
|
1080
807
|
- **Method**: `POST`
|
|
1081
808
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker`
|
|
1082
809
|
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1086
|
-
- `project_name`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1087
|
-
- `content`: URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file (required)
|
|
1088
|
-
- `environment`: Project environment variables
|
|
1089
|
-
|
|
1090
|
-
### VPS_getProjectLogsV1
|
|
810
|
+
#### VPS_getProjectLogsV1
|
|
1091
811
|
|
|
1092
812
|
Retrieves aggregated log entries from all services within a Docker Compose project.
|
|
1093
813
|
|
|
@@ -1100,12 +820,7 @@ troubleshooting issues across your entire project stack.
|
|
|
1100
820
|
- **Method**: `GET`
|
|
1101
821
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs`
|
|
1102
822
|
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1106
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1107
|
-
|
|
1108
|
-
### VPS_restartProjectV1
|
|
823
|
+
#### VPS_restartProjectV1
|
|
1109
824
|
|
|
1110
825
|
Restarts all services in a Docker Compose project by stopping and starting
|
|
1111
826
|
containers in the correct dependency order.
|
|
@@ -1117,12 +832,7 @@ Use this to apply configuration changes or recover from service failures.
|
|
|
1117
832
|
- **Method**: `POST`
|
|
1118
833
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart`
|
|
1119
834
|
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1123
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1124
|
-
|
|
1125
|
-
### VPS_startProjectV1
|
|
835
|
+
#### VPS_startProjectV1
|
|
1126
836
|
|
|
1127
837
|
Starts all services in a Docker Compose project that are currently stopped.
|
|
1128
838
|
|
|
@@ -1133,12 +843,7 @@ Use this to resume a project that was previously stopped or to start services af
|
|
|
1133
843
|
- **Method**: `POST`
|
|
1134
844
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start`
|
|
1135
845
|
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1139
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1140
|
-
|
|
1141
|
-
### VPS_stopProjectV1
|
|
846
|
+
#### VPS_stopProjectV1
|
|
1142
847
|
|
|
1143
848
|
Stops all running services in a Docker Compose project while preserving
|
|
1144
849
|
container configurations and data volumes.
|
|
@@ -1150,12 +855,7 @@ Use this to temporarily halt a project without removing data or configurations.
|
|
|
1150
855
|
- **Method**: `POST`
|
|
1151
856
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop`
|
|
1152
857
|
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1156
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1157
|
-
|
|
1158
|
-
### VPS_updateProjectV1
|
|
858
|
+
#### VPS_updateProjectV1
|
|
1159
859
|
|
|
1160
860
|
Updates a Docker Compose project by pulling the latest image versions and
|
|
1161
861
|
recreating containers with new configurations.
|
|
@@ -1168,12 +868,7 @@ refresh container images to their latest versions.
|
|
|
1168
868
|
- **Method**: `POST`
|
|
1169
869
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update`
|
|
1170
870
|
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1174
|
-
- `projectName`: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
|
|
1175
|
-
|
|
1176
|
-
### VPS_activateFirewallV1
|
|
871
|
+
#### VPS_activateFirewallV1
|
|
1177
872
|
|
|
1178
873
|
Activate a firewall for a specified virtual machine.
|
|
1179
874
|
|
|
@@ -1184,12 +879,7 @@ Use this endpoint to apply firewall rules to VPS instances.
|
|
|
1184
879
|
- **Method**: `POST`
|
|
1185
880
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}`
|
|
1186
881
|
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
- `firewallId`: Firewall ID (required)
|
|
1190
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1191
|
-
|
|
1192
|
-
### VPS_deactivateFirewallV1
|
|
882
|
+
#### VPS_deactivateFirewallV1
|
|
1193
883
|
|
|
1194
884
|
Deactivate a firewall for a specified virtual machine.
|
|
1195
885
|
|
|
@@ -1198,12 +888,7 @@ Use this endpoint to remove firewall protection from VPS instances.
|
|
|
1198
888
|
- **Method**: `POST`
|
|
1199
889
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}`
|
|
1200
890
|
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
- `firewallId`: Firewall ID (required)
|
|
1204
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1205
|
-
|
|
1206
|
-
### VPS_getFirewallDetailsV1
|
|
891
|
+
#### VPS_getFirewallDetailsV1
|
|
1207
892
|
|
|
1208
893
|
Retrieve firewall by its ID and rules associated with it.
|
|
1209
894
|
|
|
@@ -1212,11 +897,7 @@ Use this endpoint to view specific firewall configuration and rules.
|
|
|
1212
897
|
- **Method**: `GET`
|
|
1213
898
|
- **Path**: `/api/vps/v1/firewall/{firewallId}`
|
|
1214
899
|
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
- `firewallId`: Firewall ID (required)
|
|
1218
|
-
|
|
1219
|
-
### VPS_deleteFirewallV1
|
|
900
|
+
#### VPS_deleteFirewallV1
|
|
1220
901
|
|
|
1221
902
|
Delete a specified firewall.
|
|
1222
903
|
|
|
@@ -1227,11 +908,7 @@ Use this endpoint to remove unused firewall configurations.
|
|
|
1227
908
|
- **Method**: `DELETE`
|
|
1228
909
|
- **Path**: `/api/vps/v1/firewall/{firewallId}`
|
|
1229
910
|
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
- `firewallId`: Firewall ID (required)
|
|
1233
|
-
|
|
1234
|
-
### VPS_getFirewallListV1
|
|
911
|
+
#### VPS_getFirewallListV1
|
|
1235
912
|
|
|
1236
913
|
Retrieve all available firewalls.
|
|
1237
914
|
|
|
@@ -1240,11 +917,7 @@ Use this endpoint to view existing firewall configurations.
|
|
|
1240
917
|
- **Method**: `GET`
|
|
1241
918
|
- **Path**: `/api/vps/v1/firewall`
|
|
1242
919
|
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
- `page`: Page number
|
|
1246
|
-
|
|
1247
|
-
### VPS_createNewFirewallV1
|
|
920
|
+
#### VPS_createNewFirewallV1
|
|
1248
921
|
|
|
1249
922
|
Create a new firewall.
|
|
1250
923
|
|
|
@@ -1253,11 +926,7 @@ Use this endpoint to set up new firewall configurations for VPS security.
|
|
|
1253
926
|
- **Method**: `POST`
|
|
1254
927
|
- **Path**: `/api/vps/v1/firewall`
|
|
1255
928
|
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
- `name`: name parameter (required)
|
|
1259
|
-
|
|
1260
|
-
### VPS_updateFirewallRuleV1
|
|
929
|
+
#### VPS_updateFirewallRuleV1
|
|
1261
930
|
|
|
1262
931
|
Update a specific firewall rule from a specified firewall.
|
|
1263
932
|
|
|
@@ -1269,16 +938,7 @@ Use this endpoint to modify existing firewall rules.
|
|
|
1269
938
|
- **Method**: `PUT`
|
|
1270
939
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/rules/{ruleId}`
|
|
1271
940
|
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
- `firewallId`: Firewall ID (required)
|
|
1275
|
-
- `ruleId`: Firewall Rule ID (required)
|
|
1276
|
-
- `protocol`: protocol parameter (required)
|
|
1277
|
-
- `port`: Port or port range, ex: 1024:2048 (required)
|
|
1278
|
-
- `source`: source parameter (required)
|
|
1279
|
-
- `source_detail`: IP range, CIDR, single IP or `any` (required)
|
|
1280
|
-
|
|
1281
|
-
### VPS_deleteFirewallRuleV1
|
|
941
|
+
#### VPS_deleteFirewallRuleV1
|
|
1282
942
|
|
|
1283
943
|
Delete a specific firewall rule from a specified firewall.
|
|
1284
944
|
|
|
@@ -1290,12 +950,7 @@ Use this endpoint to remove specific firewall rules.
|
|
|
1290
950
|
- **Method**: `DELETE`
|
|
1291
951
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/rules/{ruleId}`
|
|
1292
952
|
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
- `firewallId`: Firewall ID (required)
|
|
1296
|
-
- `ruleId`: Firewall Rule ID (required)
|
|
1297
|
-
|
|
1298
|
-
### VPS_createFirewallRuleV1
|
|
953
|
+
#### VPS_createFirewallRuleV1
|
|
1299
954
|
|
|
1300
955
|
Create new firewall rule for a specified firewall.
|
|
1301
956
|
|
|
@@ -1310,15 +965,7 @@ Use this endpoint to add new security rules to firewalls.
|
|
|
1310
965
|
- **Method**: `POST`
|
|
1311
966
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/rules`
|
|
1312
967
|
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
- `firewallId`: Firewall ID (required)
|
|
1316
|
-
- `protocol`: protocol parameter (required)
|
|
1317
|
-
- `port`: Port or port range, ex: 1024:2048 (required)
|
|
1318
|
-
- `source`: source parameter (required)
|
|
1319
|
-
- `source_detail`: IP range, CIDR, single IP or `any` (required)
|
|
1320
|
-
|
|
1321
|
-
### VPS_syncFirewallV1
|
|
968
|
+
#### VPS_syncFirewallV1
|
|
1322
969
|
|
|
1323
970
|
Sync a firewall for a specified virtual machine.
|
|
1324
971
|
|
|
@@ -1329,12 +976,7 @@ Use this endpoint to apply updated firewall rules to VPS instances.
|
|
|
1329
976
|
- **Method**: `POST`
|
|
1330
977
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}`
|
|
1331
978
|
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
- `firewallId`: Firewall ID (required)
|
|
1335
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1336
|
-
|
|
1337
|
-
### VPS_getPostInstallScriptV1
|
|
979
|
+
#### VPS_getPostInstallScriptV1
|
|
1338
980
|
|
|
1339
981
|
Retrieve post-install script by its ID.
|
|
1340
982
|
|
|
@@ -1343,11 +985,7 @@ Use this endpoint to view specific automation script details.
|
|
|
1343
985
|
- **Method**: `GET`
|
|
1344
986
|
- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
|
|
1345
987
|
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
- `postInstallScriptId`: Post-install script ID (required)
|
|
1349
|
-
|
|
1350
|
-
### VPS_updatePostInstallScriptV1
|
|
988
|
+
#### VPS_updatePostInstallScriptV1
|
|
1351
989
|
|
|
1352
990
|
Update a specific post-install script.
|
|
1353
991
|
|
|
@@ -1356,13 +994,7 @@ Use this endpoint to modify existing automation scripts.
|
|
|
1356
994
|
- **Method**: `PUT`
|
|
1357
995
|
- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
|
|
1358
996
|
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
- `postInstallScriptId`: Post-install script ID (required)
|
|
1362
|
-
- `name`: Name of the script (required)
|
|
1363
|
-
- `content`: Content of the script (required)
|
|
1364
|
-
|
|
1365
|
-
### VPS_deletePostInstallScriptV1
|
|
997
|
+
#### VPS_deletePostInstallScriptV1
|
|
1366
998
|
|
|
1367
999
|
Delete a post-install script from your account.
|
|
1368
1000
|
|
|
@@ -1371,11 +1003,7 @@ Use this endpoint to remove unused automation scripts.
|
|
|
1371
1003
|
- **Method**: `DELETE`
|
|
1372
1004
|
- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
|
|
1373
1005
|
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
- `postInstallScriptId`: Post-install script ID (required)
|
|
1377
|
-
|
|
1378
|
-
### VPS_getPostInstallScriptsV1
|
|
1006
|
+
#### VPS_getPostInstallScriptsV1
|
|
1379
1007
|
|
|
1380
1008
|
Retrieve post-install scripts associated with your account.
|
|
1381
1009
|
|
|
@@ -1384,11 +1012,7 @@ Use this endpoint to view available automation scripts for VPS deployment.
|
|
|
1384
1012
|
- **Method**: `GET`
|
|
1385
1013
|
- **Path**: `/api/vps/v1/post-install-scripts`
|
|
1386
1014
|
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
- `page`: Page number
|
|
1390
|
-
|
|
1391
|
-
### VPS_createPostInstallScriptV1
|
|
1015
|
+
#### VPS_createPostInstallScriptV1
|
|
1392
1016
|
|
|
1393
1017
|
Add a new post-install script to your account, which can then be used after virtual machine installation.
|
|
1394
1018
|
|
|
@@ -1401,12 +1025,7 @@ Use this endpoint to create automation scripts for VPS setup tasks.
|
|
|
1401
1025
|
- **Method**: `POST`
|
|
1402
1026
|
- **Path**: `/api/vps/v1/post-install-scripts`
|
|
1403
1027
|
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
- `name`: Name of the script (required)
|
|
1407
|
-
- `content`: Content of the script (required)
|
|
1408
|
-
|
|
1409
|
-
### VPS_attachPublicKeyV1
|
|
1028
|
+
#### VPS_attachPublicKeyV1
|
|
1410
1029
|
|
|
1411
1030
|
Attach existing public keys from your account to a specified virtual machine.
|
|
1412
1031
|
|
|
@@ -1417,12 +1036,7 @@ Use this endpoint to enable SSH key authentication for VPS instances.
|
|
|
1417
1036
|
- **Method**: `POST`
|
|
1418
1037
|
- **Path**: `/api/vps/v1/public-keys/attach/{virtualMachineId}`
|
|
1419
1038
|
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1423
|
-
- `ids`: Public Key IDs to attach (required)
|
|
1424
|
-
|
|
1425
|
-
### VPS_deletePublicKeyV1
|
|
1039
|
+
#### VPS_deletePublicKeyV1
|
|
1426
1040
|
|
|
1427
1041
|
Delete a public key from your account.
|
|
1428
1042
|
|
|
@@ -1433,11 +1047,7 @@ Use this endpoint to remove unused SSH keys from account.
|
|
|
1433
1047
|
- **Method**: `DELETE`
|
|
1434
1048
|
- **Path**: `/api/vps/v1/public-keys/{publicKeyId}`
|
|
1435
1049
|
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
- `publicKeyId`: Public Key ID (required)
|
|
1439
|
-
|
|
1440
|
-
### VPS_getPublicKeysV1
|
|
1050
|
+
#### VPS_getPublicKeysV1
|
|
1441
1051
|
|
|
1442
1052
|
Retrieve public keys associated with your account.
|
|
1443
1053
|
|
|
@@ -1446,11 +1056,7 @@ Use this endpoint to view available SSH keys for VPS authentication.
|
|
|
1446
1056
|
- **Method**: `GET`
|
|
1447
1057
|
- **Path**: `/api/vps/v1/public-keys`
|
|
1448
1058
|
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
- `page`: Page number
|
|
1452
|
-
|
|
1453
|
-
### VPS_createPublicKeyV1
|
|
1059
|
+
#### VPS_createPublicKeyV1
|
|
1454
1060
|
|
|
1455
1061
|
Add a new public key to your account.
|
|
1456
1062
|
|
|
@@ -1459,12 +1065,7 @@ Use this endpoint to register SSH keys for VPS authentication.
|
|
|
1459
1065
|
- **Method**: `POST`
|
|
1460
1066
|
- **Path**: `/api/vps/v1/public-keys`
|
|
1461
1067
|
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
- `name`: name parameter (required)
|
|
1465
|
-
- `key`: key parameter (required)
|
|
1466
|
-
|
|
1467
|
-
### VPS_getTemplateDetailsV1
|
|
1068
|
+
#### VPS_getTemplateDetailsV1
|
|
1468
1069
|
|
|
1469
1070
|
Retrieve detailed information about a specific OS template for virtual machines.
|
|
1470
1071
|
|
|
@@ -1473,11 +1074,7 @@ Use this endpoint to view specific template specifications before deployment.
|
|
|
1473
1074
|
- **Method**: `GET`
|
|
1474
1075
|
- **Path**: `/api/vps/v1/templates/{templateId}`
|
|
1475
1076
|
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
- `templateId`: Template ID (required)
|
|
1479
|
-
|
|
1480
|
-
### VPS_getTemplatesV1
|
|
1077
|
+
#### VPS_getTemplatesV1
|
|
1481
1078
|
|
|
1482
1079
|
Retrieve available OS templates for virtual machines.
|
|
1483
1080
|
|
|
@@ -1486,9 +1083,7 @@ Use this endpoint to view operating system options before creating or recreating
|
|
|
1486
1083
|
- **Method**: `GET`
|
|
1487
1084
|
- **Path**: `/api/vps/v1/templates`
|
|
1488
1085
|
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
### VPS_getActionDetailsV1
|
|
1086
|
+
#### VPS_getActionDetailsV1
|
|
1492
1087
|
|
|
1493
1088
|
Retrieve detailed information about a specific action performed on a specified virtual machine.
|
|
1494
1089
|
|
|
@@ -1497,12 +1092,7 @@ Use this endpoint to monitor specific VPS operation status and details.
|
|
|
1497
1092
|
- **Method**: `GET`
|
|
1498
1093
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}`
|
|
1499
1094
|
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1503
|
-
- `actionId`: Action ID (required)
|
|
1504
|
-
|
|
1505
|
-
### VPS_getActionsV1
|
|
1095
|
+
#### VPS_getActionsV1
|
|
1506
1096
|
|
|
1507
1097
|
Retrieve actions performed on a specified virtual machine.
|
|
1508
1098
|
|
|
@@ -1516,12 +1106,7 @@ Use this endpoint to view VPS operation history and troubleshoot issues.
|
|
|
1516
1106
|
- **Method**: `GET`
|
|
1517
1107
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions`
|
|
1518
1108
|
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1522
|
-
- `page`: Page number
|
|
1523
|
-
|
|
1524
|
-
### VPS_getAttachedPublicKeysV1
|
|
1109
|
+
#### VPS_getAttachedPublicKeysV1
|
|
1525
1110
|
|
|
1526
1111
|
Retrieve public keys attached to a specified virtual machine.
|
|
1527
1112
|
|
|
@@ -1530,12 +1115,7 @@ Use this endpoint to view SSH keys configured for specific VPS instances.
|
|
|
1530
1115
|
- **Method**: `GET`
|
|
1531
1116
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys`
|
|
1532
1117
|
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1536
|
-
- `page`: Page number
|
|
1537
|
-
|
|
1538
|
-
### VPS_getBackupsV1
|
|
1118
|
+
#### VPS_getBackupsV1
|
|
1539
1119
|
|
|
1540
1120
|
Retrieve backups for a specified virtual machine.
|
|
1541
1121
|
|
|
@@ -1544,12 +1124,7 @@ Use this endpoint to view available backup points for VPS data recovery.
|
|
|
1544
1124
|
- **Method**: `GET`
|
|
1545
1125
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups`
|
|
1546
1126
|
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1550
|
-
- `page`: Page number
|
|
1551
|
-
|
|
1552
|
-
### VPS_restoreBackupV1
|
|
1127
|
+
#### VPS_restoreBackupV1
|
|
1553
1128
|
|
|
1554
1129
|
Restore a backup for a specified virtual machine.
|
|
1555
1130
|
|
|
@@ -1562,12 +1137,7 @@ Use this endpoint to recover VPS data from backup points.
|
|
|
1562
1137
|
- **Method**: `POST`
|
|
1563
1138
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore`
|
|
1564
1139
|
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1568
|
-
- `backupId`: Backup ID (required)
|
|
1569
|
-
|
|
1570
|
-
### VPS_setHostnameV1
|
|
1140
|
+
#### VPS_setHostnameV1
|
|
1571
1141
|
|
|
1572
1142
|
Set hostname for a specified virtual machine.
|
|
1573
1143
|
|
|
@@ -1580,12 +1150,7 @@ Use this endpoint to configure custom hostnames for VPS instances.
|
|
|
1580
1150
|
- **Method**: `PUT`
|
|
1581
1151
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/hostname`
|
|
1582
1152
|
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1586
|
-
- `hostname`: hostname parameter (required)
|
|
1587
|
-
|
|
1588
|
-
### VPS_resetHostnameV1
|
|
1153
|
+
#### VPS_resetHostnameV1
|
|
1589
1154
|
|
|
1590
1155
|
Reset hostname and PTR record of a specified virtual machine to default value.
|
|
1591
1156
|
|
|
@@ -1594,11 +1159,7 @@ Use this endpoint to restore default hostname configuration for VPS instances.
|
|
|
1594
1159
|
- **Method**: `DELETE`
|
|
1595
1160
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/hostname`
|
|
1596
1161
|
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1600
|
-
|
|
1601
|
-
### VPS_getVirtualMachineDetailsV1
|
|
1162
|
+
#### VPS_getVirtualMachineDetailsV1
|
|
1602
1163
|
|
|
1603
1164
|
Retrieve detailed information about a specified virtual machine.
|
|
1604
1165
|
|
|
@@ -1607,11 +1168,7 @@ Use this endpoint to view comprehensive VPS configuration and status.
|
|
|
1607
1168
|
- **Method**: `GET`
|
|
1608
1169
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}`
|
|
1609
1170
|
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1613
|
-
|
|
1614
|
-
### VPS_getVirtualMachinesV1
|
|
1171
|
+
#### VPS_getVirtualMachinesV1
|
|
1615
1172
|
|
|
1616
1173
|
Retrieve all available virtual machines.
|
|
1617
1174
|
|
|
@@ -1620,9 +1177,7 @@ Use this endpoint to view available VPS instances.
|
|
|
1620
1177
|
- **Method**: `GET`
|
|
1621
1178
|
- **Path**: `/api/vps/v1/virtual-machines`
|
|
1622
1179
|
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
### VPS_purchaseNewVirtualMachineV1
|
|
1180
|
+
#### VPS_purchaseNewVirtualMachineV1
|
|
1626
1181
|
|
|
1627
1182
|
Purchase and setup a new virtual machine.
|
|
1628
1183
|
|
|
@@ -1636,14 +1191,7 @@ Use this endpoint to create new VPS instances.
|
|
|
1636
1191
|
- **Method**: `POST`
|
|
1637
1192
|
- **Path**: `/api/vps/v1/virtual-machines`
|
|
1638
1193
|
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
- `item_id`: Catalog price item ID (required)
|
|
1642
|
-
- `payment_method_id`: Payment method ID, default will be used if not provided
|
|
1643
|
-
- `setup`: setup parameter (required)
|
|
1644
|
-
- `coupons`: Discount coupon codes
|
|
1645
|
-
|
|
1646
|
-
### VPS_getScanMetricsV1
|
|
1194
|
+
#### VPS_getScanMetricsV1
|
|
1647
1195
|
|
|
1648
1196
|
Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner
|
|
1649
1197
|
installed on a specified virtual machine.
|
|
@@ -1658,11 +1206,7 @@ Use this endpoint to monitor VPS security scan results and threat detection.
|
|
|
1658
1206
|
- **Method**: `GET`
|
|
1659
1207
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
|
|
1660
1208
|
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1664
|
-
|
|
1665
|
-
### VPS_installMonarxV1
|
|
1209
|
+
#### VPS_installMonarxV1
|
|
1666
1210
|
|
|
1667
1211
|
Install the Monarx malware scanner on a specified virtual machine.
|
|
1668
1212
|
|
|
@@ -1676,11 +1220,7 @@ Use this endpoint to enable malware protection on VPS instances.
|
|
|
1676
1220
|
- **Method**: `POST`
|
|
1677
1221
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
|
|
1678
1222
|
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1682
|
-
|
|
1683
|
-
### VPS_uninstallMonarxV1
|
|
1223
|
+
#### VPS_uninstallMonarxV1
|
|
1684
1224
|
|
|
1685
1225
|
Uninstall the Monarx malware scanner on a specified virtual machine.
|
|
1686
1226
|
|
|
@@ -1691,11 +1231,7 @@ Use this endpoint to remove malware scanner from VPS instances.
|
|
|
1691
1231
|
- **Method**: `DELETE`
|
|
1692
1232
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
|
|
1693
1233
|
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1697
|
-
|
|
1698
|
-
### VPS_getMetricsV1
|
|
1234
|
+
#### VPS_getMetricsV1
|
|
1699
1235
|
|
|
1700
1236
|
Retrieve historical metrics for a specified virtual machine.
|
|
1701
1237
|
|
|
@@ -1711,13 +1247,7 @@ Use this endpoint to monitor VPS performance and resource utilization over time.
|
|
|
1711
1247
|
- **Method**: `GET`
|
|
1712
1248
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/metrics`
|
|
1713
1249
|
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1717
|
-
- `date_from`: date_from parameter (required)
|
|
1718
|
-
- `date_to`: date_to parameter (required)
|
|
1719
|
-
|
|
1720
|
-
### VPS_setNameserversV1
|
|
1250
|
+
#### VPS_setNameserversV1
|
|
1721
1251
|
|
|
1722
1252
|
Set nameservers for a specified virtual machine.
|
|
1723
1253
|
|
|
@@ -1729,14 +1259,7 @@ Use this endpoint to configure custom DNS resolvers for VPS instances.
|
|
|
1729
1259
|
- **Method**: `PUT`
|
|
1730
1260
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers`
|
|
1731
1261
|
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1735
|
-
- `ns1`: ns1 parameter (required)
|
|
1736
|
-
- `ns2`: ns2 parameter
|
|
1737
|
-
- `ns3`: ns3 parameter
|
|
1738
|
-
|
|
1739
|
-
### VPS_createPTRRecordV1
|
|
1262
|
+
#### VPS_createPTRRecordV1
|
|
1740
1263
|
|
|
1741
1264
|
Create or update a PTR (Pointer) record for a specified virtual machine.
|
|
1742
1265
|
|
|
@@ -1745,13 +1268,7 @@ Use this endpoint to configure reverse DNS lookup for VPS IP addresses.
|
|
|
1745
1268
|
- **Method**: `POST`
|
|
1746
1269
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}`
|
|
1747
1270
|
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1751
|
-
- `ipAddressId`: IP Address ID (required)
|
|
1752
|
-
- `domain`: Pointer record domain (required)
|
|
1753
|
-
|
|
1754
|
-
### VPS_deletePTRRecordV1
|
|
1271
|
+
#### VPS_deletePTRRecordV1
|
|
1755
1272
|
|
|
1756
1273
|
Delete a PTR (Pointer) record for a specified virtual machine.
|
|
1757
1274
|
|
|
@@ -1763,12 +1280,7 @@ Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
|
1763
1280
|
- **Method**: `DELETE`
|
|
1764
1281
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}`
|
|
1765
1282
|
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1769
|
-
- `ipAddressId`: IP Address ID (required)
|
|
1770
|
-
|
|
1771
|
-
### VPS_setPanelPasswordV1
|
|
1283
|
+
#### VPS_setPanelPasswordV1
|
|
1772
1284
|
|
|
1773
1285
|
Set panel password for a specified virtual machine.
|
|
1774
1286
|
|
|
@@ -1781,12 +1293,7 @@ Use this endpoint to configure control panel access credentials for VPS instance
|
|
|
1781
1293
|
- **Method**: `PUT`
|
|
1782
1294
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password`
|
|
1783
1295
|
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1787
|
-
- `password`: Panel password for the virtual machine (required)
|
|
1788
|
-
|
|
1789
|
-
### VPS_startRecoveryModeV1
|
|
1296
|
+
#### VPS_startRecoveryModeV1
|
|
1790
1297
|
|
|
1791
1298
|
Initiate recovery mode for a specified virtual machine.
|
|
1792
1299
|
|
|
@@ -1801,12 +1308,7 @@ Use this endpoint to enable system rescue operations on VPS instances.
|
|
|
1801
1308
|
- **Method**: `POST`
|
|
1802
1309
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recovery`
|
|
1803
1310
|
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1807
|
-
- `root_password`: Temporary root password for recovery mode (required)
|
|
1808
|
-
|
|
1809
|
-
### VPS_stopRecoveryModeV1
|
|
1311
|
+
#### VPS_stopRecoveryModeV1
|
|
1810
1312
|
|
|
1811
1313
|
Stop recovery mode for a specified virtual machine.
|
|
1812
1314
|
|
|
@@ -1817,11 +1319,7 @@ Use this endpoint to exit system rescue mode and return VPS to normal operation.
|
|
|
1817
1319
|
- **Method**: `DELETE`
|
|
1818
1320
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recovery`
|
|
1819
1321
|
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1823
|
-
|
|
1824
|
-
### VPS_recreateVirtualMachineV1
|
|
1322
|
+
#### VPS_recreateVirtualMachineV1
|
|
1825
1323
|
|
|
1826
1324
|
Recreate a virtual machine from scratch.
|
|
1827
1325
|
|
|
@@ -1845,18 +1343,7 @@ Use this endpoint to completely rebuild VPS instances with fresh OS installation
|
|
|
1845
1343
|
- **Method**: `POST`
|
|
1846
1344
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recreate`
|
|
1847
1345
|
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1851
|
-
- `template_id`: Template ID (required)
|
|
1852
|
-
- `password`: Root password for the virtual machine. If not provided, random password will be generated.
|
|
1853
|
-
Password will not be shown in the response.
|
|
1854
|
-
- `panel_password`: Panel password for the panel-based OS template. If not provided, random password will be generated.
|
|
1855
|
-
If OS does not support panel_password this field will be ignored.
|
|
1856
|
-
Password will not be shown in the response.
|
|
1857
|
-
- `post_install_script_id`: Post-install script to execute after virtual machine was recreated
|
|
1858
|
-
|
|
1859
|
-
### VPS_restartVirtualMachineV1
|
|
1346
|
+
#### VPS_restartVirtualMachineV1
|
|
1860
1347
|
|
|
1861
1348
|
Restart a specified virtual machine by fully stopping and starting it.
|
|
1862
1349
|
|
|
@@ -1867,11 +1354,7 @@ Use this endpoint to reboot VPS instances.
|
|
|
1867
1354
|
- **Method**: `POST`
|
|
1868
1355
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/restart`
|
|
1869
1356
|
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1873
|
-
|
|
1874
|
-
### VPS_setRootPasswordV1
|
|
1357
|
+
#### VPS_setRootPasswordV1
|
|
1875
1358
|
|
|
1876
1359
|
Set root password for a specified virtual machine.
|
|
1877
1360
|
|
|
@@ -1883,12 +1366,7 @@ Use this endpoint to update administrator credentials for VPS instances.
|
|
|
1883
1366
|
- **Method**: `PUT`
|
|
1884
1367
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/root-password`
|
|
1885
1368
|
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1889
|
-
- `password`: Root password for the virtual machine (required)
|
|
1890
|
-
|
|
1891
|
-
### VPS_setupPurchasedVirtualMachineV1
|
|
1369
|
+
#### VPS_setupPurchasedVirtualMachineV1
|
|
1892
1370
|
|
|
1893
1371
|
Setup newly purchased virtual machine with `initial` state.
|
|
1894
1372
|
|
|
@@ -1897,22 +1375,7 @@ Use this endpoint to configure and initialize purchased VPS instances.
|
|
|
1897
1375
|
- **Method**: `POST`
|
|
1898
1376
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/setup`
|
|
1899
1377
|
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1903
|
-
- `template_id`: Template ID (required)
|
|
1904
|
-
- `data_center_id`: Data center ID (required)
|
|
1905
|
-
- `post_install_script_id`: Post-install script ID
|
|
1906
|
-
- `password`: Password for the virtual machine. If not provided, random password will be generated.
|
|
1907
|
-
Password will not be shown in the response.
|
|
1908
|
-
- `hostname`: Override default hostname of the virtual machine
|
|
1909
|
-
- `install_monarx`: Install Monarx malware scanner (if supported)
|
|
1910
|
-
- `enable_backups`: Enable weekly backup schedule
|
|
1911
|
-
- `ns1`: Name server 1
|
|
1912
|
-
- `ns2`: Name server 2
|
|
1913
|
-
- `public_key`: Use SSH key
|
|
1914
|
-
|
|
1915
|
-
### VPS_getSnapshotV1
|
|
1378
|
+
#### VPS_getSnapshotV1
|
|
1916
1379
|
|
|
1917
1380
|
Retrieve snapshot for a specified virtual machine.
|
|
1918
1381
|
|
|
@@ -1921,11 +1384,7 @@ Use this endpoint to view current VPS snapshot information.
|
|
|
1921
1384
|
- **Method**: `GET`
|
|
1922
1385
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
|
|
1923
1386
|
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1927
|
-
|
|
1928
|
-
### VPS_createSnapshotV1
|
|
1387
|
+
#### VPS_createSnapshotV1
|
|
1929
1388
|
|
|
1930
1389
|
Create a snapshot of a specified virtual machine.
|
|
1931
1390
|
|
|
@@ -1941,11 +1400,7 @@ Use this endpoint to capture VPS state for backup and recovery purposes.
|
|
|
1941
1400
|
- **Method**: `POST`
|
|
1942
1401
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
|
|
1943
1402
|
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1947
|
-
|
|
1948
|
-
### VPS_deleteSnapshotV1
|
|
1403
|
+
#### VPS_deleteSnapshotV1
|
|
1949
1404
|
|
|
1950
1405
|
Delete a snapshot of a specified virtual machine.
|
|
1951
1406
|
|
|
@@ -1954,11 +1409,7 @@ Use this endpoint to remove VPS snapshots.
|
|
|
1954
1409
|
- **Method**: `DELETE`
|
|
1955
1410
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
|
|
1956
1411
|
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1960
|
-
|
|
1961
|
-
### VPS_restoreSnapshotV1
|
|
1412
|
+
#### VPS_restoreSnapshotV1
|
|
1962
1413
|
|
|
1963
1414
|
Restore a specified virtual machine to a previous state using a snapshot.
|
|
1964
1415
|
|
|
@@ -1970,11 +1421,7 @@ Use this endpoint to revert VPS instances to previous saved states.
|
|
|
1970
1421
|
- **Method**: `POST`
|
|
1971
1422
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore`
|
|
1972
1423
|
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1976
|
-
|
|
1977
|
-
### VPS_startVirtualMachineV1
|
|
1424
|
+
#### VPS_startVirtualMachineV1
|
|
1978
1425
|
|
|
1979
1426
|
Start a specified virtual machine.
|
|
1980
1427
|
|
|
@@ -1985,11 +1432,7 @@ Use this endpoint to power on stopped VPS instances.
|
|
|
1985
1432
|
- **Method**: `POST`
|
|
1986
1433
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/start`
|
|
1987
1434
|
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1991
|
-
|
|
1992
|
-
### VPS_stopVirtualMachineV1
|
|
1435
|
+
#### VPS_stopVirtualMachineV1
|
|
1993
1436
|
|
|
1994
1437
|
Stop a specified virtual machine.
|
|
1995
1438
|
|
|
@@ -1999,7 +1442,3 @@ Use this endpoint to power off running VPS instances.
|
|
|
1999
1442
|
|
|
2000
1443
|
- **Method**: `POST`
|
|
2001
1444
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/stop`
|
|
2002
|
-
|
|
2003
|
-
**Parameters**:
|
|
2004
|
-
|
|
2005
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|