hostinger-api-mcp 0.0.13 → 0.0.14
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/README.md +174 -116
- package/package.json +1 -1
- package/server.js +425 -512
- package/server.ts +425 -512
- package/types.d.ts +273 -280
package/README.md
CHANGED
|
@@ -148,7 +148,7 @@ We recommend use other payment methods than `credit_card` if you encounter this
|
|
|
148
148
|
|
|
149
149
|
- `payment_method_id`: Payment method ID (required)
|
|
150
150
|
- `items`: items property (required)
|
|
151
|
-
- `coupons`:
|
|
151
|
+
- `coupons`: Discount coupon codes
|
|
152
152
|
|
|
153
153
|
### billing_setDefaultPaymentMethodV1
|
|
154
154
|
|
|
@@ -157,9 +157,7 @@ This endpoint sets default payment method for your account.
|
|
|
157
157
|
- **Method**: `POST`
|
|
158
158
|
- **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
|
|
159
159
|
|
|
160
|
-
**Parameters**:
|
|
161
160
|
|
|
162
|
-
- `paymentMethodId`: Payment method ID (required)
|
|
163
161
|
|
|
164
162
|
### billing_deletePaymentMethodV1
|
|
165
163
|
|
|
@@ -168,9 +166,7 @@ This endpoint deletes a payment method from your account.
|
|
|
168
166
|
- **Method**: `DELETE`
|
|
169
167
|
- **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
|
|
170
168
|
|
|
171
|
-
**Parameters**:
|
|
172
169
|
|
|
173
|
-
- `paymentMethodId`: Payment method ID (required)
|
|
174
170
|
|
|
175
171
|
### billing_getPaymentMethodListV1
|
|
176
172
|
|
|
@@ -190,9 +186,7 @@ This endpoint cancels a subscription and stops any further billing.
|
|
|
190
186
|
- **Method**: `DELETE`
|
|
191
187
|
- **Path**: `/api/billing/v1/subscriptions/{subscriptionId}`
|
|
192
188
|
|
|
193
|
-
**Parameters**:
|
|
194
189
|
|
|
195
|
-
- `subscriptionId`: Subscription ID (required)
|
|
196
190
|
|
|
197
191
|
### billing_getSubscriptionListV1
|
|
198
192
|
|
|
@@ -210,10 +204,7 @@ This endpoint retrieves particular DNS snapshot with the contents of DNS zone re
|
|
|
210
204
|
- **Method**: `GET`
|
|
211
205
|
- **Path**: `/api/dns/v1/snapshots/{domain}/{snapshotId}`
|
|
212
206
|
|
|
213
|
-
**Parameters**:
|
|
214
207
|
|
|
215
|
-
- `domain`: Domain name (required)
|
|
216
|
-
- `snapshotId`: Snapshot ID (required)
|
|
217
208
|
|
|
218
209
|
### DNS_getSnapshotListV1
|
|
219
210
|
|
|
@@ -222,9 +213,7 @@ This endpoint retrieves list of DNS snapshots.
|
|
|
222
213
|
- **Method**: `GET`
|
|
223
214
|
- **Path**: `/api/dns/v1/snapshots/{domain}`
|
|
224
215
|
|
|
225
|
-
**Parameters**:
|
|
226
216
|
|
|
227
|
-
- `domain`: Domain name (required)
|
|
228
217
|
|
|
229
218
|
### DNS_restoreSnapshotV1
|
|
230
219
|
|
|
@@ -233,10 +222,7 @@ This endpoint restores DNS zone to the selected snapshot.
|
|
|
233
222
|
- **Method**: `POST`
|
|
234
223
|
- **Path**: `/api/dns/v1/snapshots/{domain}/{snapshotId}/restore`
|
|
235
224
|
|
|
236
|
-
**Parameters**:
|
|
237
225
|
|
|
238
|
-
- `domain`: Domain name (required)
|
|
239
|
-
- `snapshotId`: Snapshot ID (required)
|
|
240
226
|
|
|
241
227
|
### DNS_getRecordsV1
|
|
242
228
|
|
|
@@ -245,9 +231,7 @@ This endpoint retrieves DNS zone records for a specific domain.
|
|
|
245
231
|
- **Method**: `GET`
|
|
246
232
|
- **Path**: `/api/dns/v1/zones/{domain}`
|
|
247
233
|
|
|
248
|
-
**Parameters**:
|
|
249
234
|
|
|
250
|
-
- `domain`: Domain name (required)
|
|
251
235
|
|
|
252
236
|
### DNS_updateZoneRecordsV1
|
|
253
237
|
|
|
@@ -261,7 +245,6 @@ Otherwise existing records will be updated and new records will be added.
|
|
|
261
245
|
|
|
262
246
|
**Parameters**:
|
|
263
247
|
|
|
264
|
-
- `domain`: Domain name (required)
|
|
265
248
|
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created.
|
|
266
249
|
- `zone`: zone property (required)
|
|
267
250
|
|
|
@@ -277,9 +260,7 @@ refer to the `Update zone records` endpoint.
|
|
|
277
260
|
- **Method**: `DELETE`
|
|
278
261
|
- **Path**: `/api/dns/v1/zones/{domain}`
|
|
279
262
|
|
|
280
|
-
**Parameters**:
|
|
281
263
|
|
|
282
|
-
- `domain`: Domain name (required)
|
|
283
264
|
|
|
284
265
|
### DNS_resetZoneRecordsV1
|
|
285
266
|
|
|
@@ -290,7 +271,6 @@ This endpoint resets DNS zone to the default records.
|
|
|
290
271
|
|
|
291
272
|
**Parameters**:
|
|
292
273
|
|
|
293
|
-
- `domain`: Domain name (required)
|
|
294
274
|
- `sync`: Determines if operation should be run synchronously
|
|
295
275
|
- `reset_email_records`: Determines if email records should be reset
|
|
296
276
|
- `whitelisted_record_types`: Specifies which record types to not reset
|
|
@@ -307,7 +287,6 @@ If there is validation error, the response will fail with `422 Validation error`
|
|
|
307
287
|
|
|
308
288
|
**Parameters**:
|
|
309
289
|
|
|
310
|
-
- `domain`: Domain name (required)
|
|
311
290
|
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created.
|
|
312
291
|
- `zone`: zone property (required)
|
|
313
292
|
|
|
@@ -322,9 +301,69 @@ Endpoint has rate limit of 10 requests per minute.
|
|
|
322
301
|
|
|
323
302
|
**Parameters**:
|
|
324
303
|
|
|
325
|
-
- `domain`:
|
|
326
|
-
- `tlds`:
|
|
327
|
-
- `with_alternatives`:
|
|
304
|
+
- `domain`: Domain name without TLD (required)
|
|
305
|
+
- `tlds`: TLDs to check (without trailing dot) (required)
|
|
306
|
+
- `with_alternatives`: Should response include alternatives
|
|
307
|
+
|
|
308
|
+
### domains_getForwardingDataV1
|
|
309
|
+
|
|
310
|
+
This endpoint retrieves domain forwarding data.
|
|
311
|
+
|
|
312
|
+
- **Method**: `GET`
|
|
313
|
+
- **Path**: `/api/domains/v1/forwarding/{domain}`
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
### domains_deleteForwardingDataV1
|
|
318
|
+
|
|
319
|
+
This endpoint deletes domain forwarding data.
|
|
320
|
+
|
|
321
|
+
- **Method**: `DELETE`
|
|
322
|
+
- **Path**: `/api/domains/v1/forwarding/{domain}`
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
### domains_createForwardingDataV1
|
|
327
|
+
|
|
328
|
+
This endpoint creates domain forwarding data.
|
|
329
|
+
|
|
330
|
+
- **Method**: `POST`
|
|
331
|
+
- **Path**: `/api/domains/v1/forwarding`
|
|
332
|
+
|
|
333
|
+
**Parameters**:
|
|
334
|
+
|
|
335
|
+
- `domain`: Domain name (required)
|
|
336
|
+
- `redirect_type`: Redirect type (required)
|
|
337
|
+
- `redirect_url`: URL to forward domain to (required)
|
|
338
|
+
|
|
339
|
+
### domains_enableDomainLockV1
|
|
340
|
+
|
|
341
|
+
This endpoint enables domain lock for the domain. When domain lock is enabled,
|
|
342
|
+
the domain cannot be transferred to another registrar without first disabling the lock.
|
|
343
|
+
|
|
344
|
+
- **Method**: `PUT`
|
|
345
|
+
- **Path**: `/api/domains/v1/portfolio/{domain}/domain-lock`
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
### domains_disableDomainLockV1
|
|
350
|
+
|
|
351
|
+
This endpoint disables domain lock for the domain. Domain lock needs to be disabled
|
|
352
|
+
before transferring the domain to another registrar.
|
|
353
|
+
|
|
354
|
+
- **Method**: `DELETE`
|
|
355
|
+
- **Path**: `/api/domains/v1/portfolio/{domain}/domain-lock`
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### domains_getDomainV1
|
|
360
|
+
|
|
361
|
+
This endpoint retrieves details for specified domain.
|
|
362
|
+
|
|
363
|
+
- **Method**: `GET`
|
|
364
|
+
- **Path**: `/api/domains/v1/portfolio/{domain}`
|
|
365
|
+
|
|
366
|
+
|
|
328
367
|
|
|
329
368
|
### domains_getDomainListV1
|
|
330
369
|
|
|
@@ -335,6 +374,116 @@ This endpoint retrieves a list of all domains associated with your account.
|
|
|
335
374
|
|
|
336
375
|
|
|
337
376
|
|
|
377
|
+
### domains_purchaseNewDomainV1
|
|
378
|
+
|
|
379
|
+
This endpoint purchases and registers new domain. If registration fails, login to hPanel and check the domain registration status.
|
|
380
|
+
|
|
381
|
+
If no payment method is provided, default will be used.
|
|
382
|
+
|
|
383
|
+
If no WHOIS information is provided, default for that TLD will be used.
|
|
384
|
+
Before making request make sure that WHOIS information for TLD exists.
|
|
385
|
+
|
|
386
|
+
Some TLDs require `additional_details` to be provided and will be validated before making purchase.
|
|
387
|
+
|
|
388
|
+
- **Method**: `POST`
|
|
389
|
+
- **Path**: `/api/domains/v1/portfolio`
|
|
390
|
+
|
|
391
|
+
**Parameters**:
|
|
392
|
+
|
|
393
|
+
- `domain`: Domain name (required)
|
|
394
|
+
- `item_id`: Catalog price item ID (required)
|
|
395
|
+
- `payment_method_id`: Payment method ID
|
|
396
|
+
- `domain_contacts`: Domain contact information
|
|
397
|
+
- `additional_details`: Additional registration data, possible values depends on TLD
|
|
398
|
+
- `coupons`: Discount coupon codes
|
|
399
|
+
|
|
400
|
+
### domains_enablePrivacyProtectionV1
|
|
401
|
+
|
|
402
|
+
This endpoint enables privacy protection for the domain.
|
|
403
|
+
When privacy protection is enabled, the domain owner's personal information is hidden from the public WHOIS database.
|
|
404
|
+
|
|
405
|
+
- **Method**: `PUT`
|
|
406
|
+
- **Path**: `/api/domains/v1/portfolio/{domain}/privacy-protection`
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
### domains_disablePrivacyProtectionV1
|
|
411
|
+
|
|
412
|
+
This endpoint disables privacy protection for the domain.
|
|
413
|
+
When privacy protection is disabled, the domain owner's personal information is visible in the public WHOIS database.
|
|
414
|
+
|
|
415
|
+
- **Method**: `DELETE`
|
|
416
|
+
- **Path**: `/api/domains/v1/portfolio/{domain}/privacy-protection`
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
### domains_updateNameserversV1
|
|
421
|
+
|
|
422
|
+
This endpoint sets the nameservers for a specified domain.
|
|
423
|
+
|
|
424
|
+
Be aware, that improper nameserver configuration can lead to the domain being unresolvable or unavailable.
|
|
425
|
+
|
|
426
|
+
- **Method**: `PUT`
|
|
427
|
+
- **Path**: `/api/domains/v1/portfolio/{domain}/nameservers`
|
|
428
|
+
|
|
429
|
+
**Parameters**:
|
|
430
|
+
|
|
431
|
+
- `ns1`: First name server (required)
|
|
432
|
+
- `ns2`: Second name server (required)
|
|
433
|
+
- `ns3`: Third name server
|
|
434
|
+
- `ns4`: Fourth name server
|
|
435
|
+
|
|
436
|
+
### domains_getWHOISProfileV1
|
|
437
|
+
|
|
438
|
+
This endpoint retrieves a WHOIS contact profile.
|
|
439
|
+
|
|
440
|
+
- **Method**: `GET`
|
|
441
|
+
- **Path**: `/api/domains/v1/whois/{whoisId}`
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
### domains_deleteWHOISProfileV1
|
|
446
|
+
|
|
447
|
+
This endpoint deletes WHOIS contact profile.
|
|
448
|
+
|
|
449
|
+
- **Method**: `DELETE`
|
|
450
|
+
- **Path**: `/api/domains/v1/whois/{whoisId}`
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
### domains_getWHOISProfileListV1
|
|
455
|
+
|
|
456
|
+
This endpoint retrieves a list of WHOIS contact profiles.
|
|
457
|
+
|
|
458
|
+
- **Method**: `GET`
|
|
459
|
+
- **Path**: `/api/domains/v1/whois`
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
### domains_createWHOISProfileV1
|
|
464
|
+
|
|
465
|
+
This endpoint creates WHOIS contact profile.
|
|
466
|
+
|
|
467
|
+
- **Method**: `POST`
|
|
468
|
+
- **Path**: `/api/domains/v1/whois`
|
|
469
|
+
|
|
470
|
+
**Parameters**:
|
|
471
|
+
|
|
472
|
+
- `tld`: TLD of the domain (without trailing dot) (required)
|
|
473
|
+
- `country`: ISO 3166 2-letter country code (required)
|
|
474
|
+
- `entity_type`: Legal entity type (required)
|
|
475
|
+
- `tld_details`: TLD details
|
|
476
|
+
- `whois_details`: WHOIS details (required)
|
|
477
|
+
|
|
478
|
+
### domains_getWHOISProfileUsageV1
|
|
479
|
+
|
|
480
|
+
This endpoint retrieves a domain list where provided WHOIS contact profile is used.
|
|
481
|
+
|
|
482
|
+
- **Method**: `GET`
|
|
483
|
+
- **Path**: `/api/domains/v1/whois/{whoisId}/usage`
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
338
487
|
### VPS_getDataCentersListV1
|
|
339
488
|
|
|
340
489
|
This endpoint retrieves a list of all data centers available.
|
|
@@ -353,10 +502,7 @@ Only one firewall can be active for a virtual machine at a time.
|
|
|
353
502
|
- **Method**: `POST`
|
|
354
503
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}`
|
|
355
504
|
|
|
356
|
-
**Parameters**:
|
|
357
505
|
|
|
358
|
-
- `firewallId`: Firewall ID (required)
|
|
359
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
360
506
|
|
|
361
507
|
### VPS_deactivateFirewallV1
|
|
362
508
|
|
|
@@ -365,10 +511,7 @@ This endpoint deactivates a firewall for a specified virtual machine.
|
|
|
365
511
|
- **Method**: `POST`
|
|
366
512
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}`
|
|
367
513
|
|
|
368
|
-
**Parameters**:
|
|
369
514
|
|
|
370
|
-
- `firewallId`: Firewall ID (required)
|
|
371
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
372
515
|
|
|
373
516
|
### VPS_getFirewallV1
|
|
374
517
|
|
|
@@ -377,9 +520,7 @@ This endpoint retrieves firewall by its ID and rules associated with it.
|
|
|
377
520
|
- **Method**: `GET`
|
|
378
521
|
- **Path**: `/api/vps/v1/firewall/{firewallId}`
|
|
379
522
|
|
|
380
|
-
**Parameters**:
|
|
381
523
|
|
|
382
|
-
- `firewallId`: Firewall ID (required)
|
|
383
524
|
|
|
384
525
|
### VPS_deleteFirewallV1
|
|
385
526
|
|
|
@@ -390,9 +531,7 @@ Any virtual machine that has this firewall activated will automatically have it
|
|
|
390
531
|
- **Method**: `DELETE`
|
|
391
532
|
- **Path**: `/api/vps/v1/firewall/{firewallId}`
|
|
392
533
|
|
|
393
|
-
**Parameters**:
|
|
394
534
|
|
|
395
|
-
- `firewallId`: Firewall ID (required)
|
|
396
535
|
|
|
397
536
|
### VPS_getFirewallListV1
|
|
398
537
|
|
|
@@ -401,9 +540,7 @@ This endpoint retrieves a list of all firewalls available.
|
|
|
401
540
|
- **Method**: `GET`
|
|
402
541
|
- **Path**: `/api/vps/v1/firewall`
|
|
403
542
|
|
|
404
|
-
**Parameters**:
|
|
405
543
|
|
|
406
|
-
- `page`: Page number
|
|
407
544
|
|
|
408
545
|
### VPS_createNewFirewallV1
|
|
409
546
|
|
|
@@ -427,8 +564,6 @@ Any virtual machine that has this firewall activated will loose sync with the fi
|
|
|
427
564
|
|
|
428
565
|
**Parameters**:
|
|
429
566
|
|
|
430
|
-
- `firewallId`: Firewall ID (required)
|
|
431
|
-
- `ruleId`: Firewall Rule ID (required)
|
|
432
567
|
- `protocol`: protocol property (required)
|
|
433
568
|
- `port`: Port or port range, ex: 1024:2048 (required)
|
|
434
569
|
- `source`: source property (required)
|
|
@@ -443,10 +578,7 @@ Any virtual machine that has this firewall activated will loose sync with the fi
|
|
|
443
578
|
- **Method**: `DELETE`
|
|
444
579
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/rules/{ruleId}`
|
|
445
580
|
|
|
446
|
-
**Parameters**:
|
|
447
581
|
|
|
448
|
-
- `firewallId`: Firewall ID (required)
|
|
449
|
-
- `ruleId`: Firewall Rule ID (required)
|
|
450
582
|
|
|
451
583
|
### VPS_createFirewallRuleV1
|
|
452
584
|
|
|
@@ -460,7 +592,6 @@ Any virtual machine that has this firewall activated will loose sync with the fi
|
|
|
460
592
|
|
|
461
593
|
**Parameters**:
|
|
462
594
|
|
|
463
|
-
- `firewallId`: Firewall ID (required)
|
|
464
595
|
- `protocol`: protocol property (required)
|
|
465
596
|
- `port`: Port or port range, ex: 1024:2048 (required)
|
|
466
597
|
- `source`: source property (required)
|
|
@@ -475,10 +606,7 @@ Firewall can loose sync with virtual machine if the firewall has new rules added
|
|
|
475
606
|
- **Method**: `POST`
|
|
476
607
|
- **Path**: `/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}`
|
|
477
608
|
|
|
478
|
-
**Parameters**:
|
|
479
609
|
|
|
480
|
-
- `firewallId`: Firewall ID (required)
|
|
481
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
482
610
|
|
|
483
611
|
### VPS_getPostInstallScriptV1
|
|
484
612
|
|
|
@@ -487,9 +615,7 @@ This endpoint retrieves post-install script by its ID.
|
|
|
487
615
|
- **Method**: `GET`
|
|
488
616
|
- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
|
|
489
617
|
|
|
490
|
-
**Parameters**:
|
|
491
618
|
|
|
492
|
-
- `postInstallScriptId`: Post-install script ID (required)
|
|
493
619
|
|
|
494
620
|
### VPS_updatePostInstallScriptV1
|
|
495
621
|
|
|
@@ -500,7 +626,6 @@ This endpoint updates a specific post-install script.
|
|
|
500
626
|
|
|
501
627
|
**Parameters**:
|
|
502
628
|
|
|
503
|
-
- `postInstallScriptId`: Post-install script ID (required)
|
|
504
629
|
- `name`: Name of the script (required)
|
|
505
630
|
- `content`: Content of the script (required)
|
|
506
631
|
|
|
@@ -511,9 +636,7 @@ This endpoint deletes a post-install script from your account.
|
|
|
511
636
|
- **Method**: `DELETE`
|
|
512
637
|
- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
|
|
513
638
|
|
|
514
|
-
**Parameters**:
|
|
515
639
|
|
|
516
|
-
- `postInstallScriptId`: Post-install script ID (required)
|
|
517
640
|
|
|
518
641
|
### VPS_getPostInstallScriptListV1
|
|
519
642
|
|
|
@@ -522,9 +645,7 @@ This endpoint retrieves a list of post-install scripts associated with your acco
|
|
|
522
645
|
- **Method**: `GET`
|
|
523
646
|
- **Path**: `/api/vps/v1/post-install-scripts`
|
|
524
647
|
|
|
525
|
-
**Parameters**:
|
|
526
648
|
|
|
527
|
-
- `page`: Page number
|
|
528
649
|
|
|
529
650
|
### VPS_createPostInstallScriptV1
|
|
530
651
|
|
|
@@ -553,7 +674,6 @@ Multiple keys can be attached to a single virtual machine.
|
|
|
553
674
|
|
|
554
675
|
**Parameters**:
|
|
555
676
|
|
|
556
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
557
677
|
- `ids`: Public Key IDs to attach (required)
|
|
558
678
|
|
|
559
679
|
### VPS_deleteAPublicKeyV1
|
|
@@ -565,9 +685,7 @@ This endpoint deletes a public key from your account.
|
|
|
565
685
|
- **Method**: `DELETE`
|
|
566
686
|
- **Path**: `/api/vps/v1/public-keys/{publicKeyId}`
|
|
567
687
|
|
|
568
|
-
**Parameters**:
|
|
569
688
|
|
|
570
|
-
- `publicKeyId`: Public Key ID (required)
|
|
571
689
|
|
|
572
690
|
### VPS_getPublicKeyListV1
|
|
573
691
|
|
|
@@ -576,9 +694,7 @@ This endpoint retrieves a list of public keys associated with your account.
|
|
|
576
694
|
- **Method**: `GET`
|
|
577
695
|
- **Path**: `/api/vps/v1/public-keys`
|
|
578
696
|
|
|
579
|
-
**Parameters**:
|
|
580
697
|
|
|
581
|
-
- `page`: Page number
|
|
582
698
|
|
|
583
699
|
### VPS_createNewPublicKeyV1
|
|
584
700
|
|
|
@@ -600,9 +716,7 @@ This endpoint retrieves details of a specific OS template for virtual machines.
|
|
|
600
716
|
- **Method**: `GET`
|
|
601
717
|
- **Path**: `/api/vps/v1/templates/{templateId}`
|
|
602
718
|
|
|
603
|
-
**Parameters**:
|
|
604
719
|
|
|
605
|
-
- `templateId`: Template ID (required)
|
|
606
720
|
|
|
607
721
|
### VPS_getTemplateListV1
|
|
608
722
|
|
|
@@ -622,10 +736,7 @@ This endpoint allows you to view detailed information about a particular action,
|
|
|
622
736
|
- **Method**: `GET`
|
|
623
737
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}`
|
|
624
738
|
|
|
625
|
-
**Parameters**:
|
|
626
739
|
|
|
627
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
628
|
-
- `actionId`: Action ID (required)
|
|
629
740
|
|
|
630
741
|
### VPS_getActionListV1
|
|
631
742
|
|
|
@@ -638,10 +749,7 @@ such as the action name, timestamp, and status.
|
|
|
638
749
|
- **Method**: `GET`
|
|
639
750
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions`
|
|
640
751
|
|
|
641
|
-
**Parameters**:
|
|
642
752
|
|
|
643
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
644
|
-
- `page`: Page number
|
|
645
753
|
|
|
646
754
|
### VPS_getAttachedPublicKeysV1
|
|
647
755
|
|
|
@@ -650,10 +758,7 @@ This endpoint retrieves a list of public keys attached to a specified virtual ma
|
|
|
650
758
|
- **Method**: `GET`
|
|
651
759
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys`
|
|
652
760
|
|
|
653
|
-
**Parameters**:
|
|
654
761
|
|
|
655
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
656
|
-
- `page`: Page number
|
|
657
762
|
|
|
658
763
|
### VPS_deleteBackupV1
|
|
659
764
|
|
|
@@ -662,10 +767,7 @@ This endpoint deletes a specified backup for a virtual machine.
|
|
|
662
767
|
- **Method**: `DELETE`
|
|
663
768
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}`
|
|
664
769
|
|
|
665
|
-
**Parameters**:
|
|
666
770
|
|
|
667
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
668
|
-
- `backupId`: Backup ID (required)
|
|
669
771
|
|
|
670
772
|
### VPS_getBackupListV1
|
|
671
773
|
|
|
@@ -674,10 +776,7 @@ This endpoint retrieves a list of backups for a specified virtual machine.
|
|
|
674
776
|
- **Method**: `GET`
|
|
675
777
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups`
|
|
676
778
|
|
|
677
|
-
**Parameters**:
|
|
678
779
|
|
|
679
|
-
- `page`: Page number
|
|
680
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
681
780
|
|
|
682
781
|
### VPS_restoreBackupV1
|
|
683
782
|
|
|
@@ -690,10 +789,7 @@ The system will then initiate the restore process, which may take some time depe
|
|
|
690
789
|
- **Method**: `POST`
|
|
691
790
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore`
|
|
692
791
|
|
|
693
|
-
**Parameters**:
|
|
694
792
|
|
|
695
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
696
|
-
- `backupId`: Backup ID (required)
|
|
697
793
|
|
|
698
794
|
### VPS_setHostnameV1
|
|
699
795
|
|
|
@@ -707,7 +803,6 @@ you need to point your domain A/AAAA records to virtual machine IP as well.
|
|
|
707
803
|
|
|
708
804
|
**Parameters**:
|
|
709
805
|
|
|
710
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
711
806
|
- `hostname`: hostname property (required)
|
|
712
807
|
|
|
713
808
|
### VPS_resetHostnameV1
|
|
@@ -717,9 +812,7 @@ This endpoint resets the hostname and PTR record of a specified virtual machine
|
|
|
717
812
|
- **Method**: `DELETE`
|
|
718
813
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/hostname`
|
|
719
814
|
|
|
720
|
-
**Parameters**:
|
|
721
815
|
|
|
722
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
723
816
|
|
|
724
817
|
### VPS_getVirtualMachineV1
|
|
725
818
|
|
|
@@ -728,9 +821,7 @@ This endpoint retrieves detailed information about a specified virtual machine.
|
|
|
728
821
|
- **Method**: `GET`
|
|
729
822
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}`
|
|
730
823
|
|
|
731
|
-
**Parameters**:
|
|
732
824
|
|
|
733
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
734
825
|
|
|
735
826
|
### VPS_getVirtualMachineListV1
|
|
736
827
|
|
|
@@ -751,9 +842,7 @@ virtual machine and assessing the effectiveness of the malware scanner.
|
|
|
751
842
|
- **Method**: `GET`
|
|
752
843
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
|
|
753
844
|
|
|
754
|
-
**Parameters**:
|
|
755
845
|
|
|
756
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
757
846
|
|
|
758
847
|
### VPS_installMonarxV1
|
|
759
848
|
|
|
@@ -765,9 +854,7 @@ By installing Monarx, users can enhance the security of their virtual machines,
|
|
|
765
854
|
- **Method**: `POST`
|
|
766
855
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
|
|
767
856
|
|
|
768
|
-
**Parameters**:
|
|
769
857
|
|
|
770
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
771
858
|
|
|
772
859
|
### VPS_uninstallMonarxV1
|
|
773
860
|
|
|
@@ -777,9 +864,7 @@ If Monarx is not installed, the request will still be processed without any effe
|
|
|
777
864
|
- **Method**: `DELETE`
|
|
778
865
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
|
|
779
866
|
|
|
780
|
-
**Parameters**:
|
|
781
867
|
|
|
782
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
783
868
|
|
|
784
869
|
### VPS_getMetricsV1
|
|
785
870
|
|
|
@@ -796,7 +881,6 @@ It includes the following metrics:
|
|
|
796
881
|
|
|
797
882
|
**Parameters**:
|
|
798
883
|
|
|
799
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
800
884
|
- `date_from`: the date-time notation as defined by RFC 3339, section 5.6 (required)
|
|
801
885
|
- `date_to`: the date-time notation as defined by RFC 3339, section 5.6 (required)
|
|
802
886
|
|
|
@@ -810,7 +894,6 @@ Be aware, that improper nameserver configuration can lead to the virtual machine
|
|
|
810
894
|
|
|
811
895
|
**Parameters**:
|
|
812
896
|
|
|
813
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
814
897
|
- `ns1`: ns1 property (required)
|
|
815
898
|
- `ns2`: ns2 property
|
|
816
899
|
|
|
@@ -821,9 +904,7 @@ This endpoint creates or updates a PTR (Pointer) record for a specified virtual
|
|
|
821
904
|
- **Method**: `POST`
|
|
822
905
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr`
|
|
823
906
|
|
|
824
|
-
**Parameters**:
|
|
825
907
|
|
|
826
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
827
908
|
|
|
828
909
|
### VPS_deletePTRRecordV1
|
|
829
910
|
|
|
@@ -834,9 +915,7 @@ Once deleted, reverse DNS lookups to the virtual machine's IP address will no lo
|
|
|
834
915
|
- **Method**: `DELETE`
|
|
835
916
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr`
|
|
836
917
|
|
|
837
|
-
**Parameters**:
|
|
838
918
|
|
|
839
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
840
919
|
|
|
841
920
|
### VPS_setPanelPasswordV1
|
|
842
921
|
|
|
@@ -849,7 +928,6 @@ Requirements for the password is the same as in the [recreate virtual machine en
|
|
|
849
928
|
|
|
850
929
|
**Parameters**:
|
|
851
930
|
|
|
852
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
853
931
|
- `password`: Panel password for the virtual machine (required)
|
|
854
932
|
|
|
855
933
|
### VPS_startRecoveryModeV1
|
|
@@ -866,7 +944,6 @@ Virtual machine will boot recovery disk image and original disk image will be mo
|
|
|
866
944
|
|
|
867
945
|
**Parameters**:
|
|
868
946
|
|
|
869
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
870
947
|
- `root_password`: Temporary root password for recovery mode (required)
|
|
871
948
|
|
|
872
949
|
### VPS_stopRecoveryModeV1
|
|
@@ -877,9 +954,7 @@ If virtual machine is not in recovery mode, this operation will fail.
|
|
|
877
954
|
- **Method**: `DELETE`
|
|
878
955
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recovery`
|
|
879
956
|
|
|
880
|
-
**Parameters**:
|
|
881
957
|
|
|
882
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
883
958
|
|
|
884
959
|
### VPS_recreateVirtualMachineV1
|
|
885
960
|
|
|
@@ -903,7 +978,6 @@ Requirements for the password are:
|
|
|
903
978
|
|
|
904
979
|
**Parameters**:
|
|
905
980
|
|
|
906
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
907
981
|
- `template_id`: Template ID (required)
|
|
908
982
|
- `password`: Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response.
|
|
909
983
|
- `post_install_script_id`: Post-install script ID
|
|
@@ -916,9 +990,7 @@ If the virtual machine was stopped, it will be started.
|
|
|
916
990
|
- **Method**: `POST`
|
|
917
991
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/restart`
|
|
918
992
|
|
|
919
|
-
**Parameters**:
|
|
920
993
|
|
|
921
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
922
994
|
|
|
923
995
|
### VPS_setRootPasswordV1
|
|
924
996
|
|
|
@@ -930,7 +1002,6 @@ Requirements for the password is the same as in the [recreate virtual machine en
|
|
|
930
1002
|
|
|
931
1003
|
**Parameters**:
|
|
932
1004
|
|
|
933
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
934
1005
|
- `password`: Root password for the virtual machine (required)
|
|
935
1006
|
|
|
936
1007
|
### VPS_setupNewVirtualMachineV1
|
|
@@ -943,7 +1014,6 @@ New virtual machine can be purchased using [`/api/billing/v1/orders`](/#tag/bill
|
|
|
943
1014
|
|
|
944
1015
|
**Parameters**:
|
|
945
1016
|
|
|
946
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
947
1017
|
- `template_id`: Template ID (required)
|
|
948
1018
|
- `data_center_id`: Data center ID (required)
|
|
949
1019
|
- `post_install_script_id`: Post-install script ID
|
|
@@ -962,9 +1032,7 @@ This endpoint retrieves a snapshot for a specified virtual machine.
|
|
|
962
1032
|
- **Method**: `GET`
|
|
963
1033
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
|
|
964
1034
|
|
|
965
|
-
**Parameters**:
|
|
966
1035
|
|
|
967
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
968
1036
|
|
|
969
1037
|
### VPS_createSnapshotV1
|
|
970
1038
|
|
|
@@ -979,9 +1047,7 @@ and testing changes without affecting the current state of the virtual machine.
|
|
|
979
1047
|
- **Method**: `POST`
|
|
980
1048
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
|
|
981
1049
|
|
|
982
|
-
**Parameters**:
|
|
983
1050
|
|
|
984
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
985
1051
|
|
|
986
1052
|
### VPS_deleteSnapshotV1
|
|
987
1053
|
|
|
@@ -990,9 +1056,7 @@ This endpoint deletes a snapshot of a specified virtual machine.
|
|
|
990
1056
|
- **Method**: `DELETE`
|
|
991
1057
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
|
|
992
1058
|
|
|
993
|
-
**Parameters**:
|
|
994
1059
|
|
|
995
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
996
1060
|
|
|
997
1061
|
### VPS_restoreSnapshotV1
|
|
998
1062
|
|
|
@@ -1002,9 +1066,7 @@ Restoring from a snapshot allows users to revert the virtual machine to that sta
|
|
|
1002
1066
|
- **Method**: `POST`
|
|
1003
1067
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore`
|
|
1004
1068
|
|
|
1005
|
-
**Parameters**:
|
|
1006
1069
|
|
|
1007
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1008
1070
|
|
|
1009
1071
|
### VPS_startVirtualMachineV1
|
|
1010
1072
|
|
|
@@ -1014,9 +1076,7 @@ If the virtual machine is already running, the request will still be processed w
|
|
|
1014
1076
|
- **Method**: `POST`
|
|
1015
1077
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/start`
|
|
1016
1078
|
|
|
1017
|
-
**Parameters**:
|
|
1018
1079
|
|
|
1019
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1020
1080
|
|
|
1021
1081
|
### VPS_stopVirtualMachineV1
|
|
1022
1082
|
|
|
@@ -1026,6 +1086,4 @@ If the virtual machine is already stopped, the request will still be processed w
|
|
|
1026
1086
|
- **Method**: `POST`
|
|
1027
1087
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/stop`
|
|
1028
1088
|
|
|
1029
|
-
**Parameters**:
|
|
1030
1089
|
|
|
1031
|
-
- `virtualMachineId`: Virtual Machine ID (required)
|