hostinger-api-mcp 0.0.12 → 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.
Files changed (5) hide show
  1. package/README.md +177 -117
  2. package/package.json +1 -1
  3. package/server.js +425 -512
  4. package/server.ts +425 -512
  5. package/types.d.ts +273 -280
package/README.md CHANGED
@@ -79,8 +79,10 @@ To use the MCP server with SSE transport, you must run the server with the `--ss
79
79
  This will enable the server to communicate with clients using Server-Sent Events on localhost port 8100.
80
80
  Additionally, you can specify the `--host` and `--port` options to set the host and port for the server to listen on.
81
81
 
82
+ Example of running the server with SSE transport:
83
+
82
84
  ```bash
83
- node server.js --see --host 127.0.0.1 --port 8100
85
+ hostinger-api-mcp --sse --host 127.0.0.1 --port 8100
84
86
  ```
85
87
 
86
88
  ### Using as an MCP Tool Provider
@@ -146,7 +148,7 @@ We recommend use other payment methods than `credit_card` if you encounter this
146
148
 
147
149
  - `payment_method_id`: Payment method ID (required)
148
150
  - `items`: items property (required)
149
- - `coupons`: coupons property
151
+ - `coupons`: Discount coupon codes
150
152
 
151
153
  ### billing_setDefaultPaymentMethodV1
152
154
 
@@ -155,9 +157,7 @@ This endpoint sets default payment method for your account.
155
157
  - **Method**: `POST`
156
158
  - **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
157
159
 
158
- **Parameters**:
159
160
 
160
- - `paymentMethodId`: Payment method ID (required)
161
161
 
162
162
  ### billing_deletePaymentMethodV1
163
163
 
@@ -166,9 +166,7 @@ This endpoint deletes a payment method from your account.
166
166
  - **Method**: `DELETE`
167
167
  - **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
168
168
 
169
- **Parameters**:
170
169
 
171
- - `paymentMethodId`: Payment method ID (required)
172
170
 
173
171
  ### billing_getPaymentMethodListV1
174
172
 
@@ -188,9 +186,7 @@ This endpoint cancels a subscription and stops any further billing.
188
186
  - **Method**: `DELETE`
189
187
  - **Path**: `/api/billing/v1/subscriptions/{subscriptionId}`
190
188
 
191
- **Parameters**:
192
189
 
193
- - `subscriptionId`: Subscription ID (required)
194
190
 
195
191
  ### billing_getSubscriptionListV1
196
192
 
@@ -208,10 +204,7 @@ This endpoint retrieves particular DNS snapshot with the contents of DNS zone re
208
204
  - **Method**: `GET`
209
205
  - **Path**: `/api/dns/v1/snapshots/{domain}/{snapshotId}`
210
206
 
211
- **Parameters**:
212
207
 
213
- - `domain`: Domain name (required)
214
- - `snapshotId`: Snapshot ID (required)
215
208
 
216
209
  ### DNS_getSnapshotListV1
217
210
 
@@ -220,9 +213,7 @@ This endpoint retrieves list of DNS snapshots.
220
213
  - **Method**: `GET`
221
214
  - **Path**: `/api/dns/v1/snapshots/{domain}`
222
215
 
223
- **Parameters**:
224
216
 
225
- - `domain`: Domain name (required)
226
217
 
227
218
  ### DNS_restoreSnapshotV1
228
219
 
@@ -231,10 +222,7 @@ This endpoint restores DNS zone to the selected snapshot.
231
222
  - **Method**: `POST`
232
223
  - **Path**: `/api/dns/v1/snapshots/{domain}/{snapshotId}/restore`
233
224
 
234
- **Parameters**:
235
225
 
236
- - `domain`: Domain name (required)
237
- - `snapshotId`: Snapshot ID (required)
238
226
 
239
227
  ### DNS_getRecordsV1
240
228
 
@@ -243,9 +231,7 @@ This endpoint retrieves DNS zone records for a specific domain.
243
231
  - **Method**: `GET`
244
232
  - **Path**: `/api/dns/v1/zones/{domain}`
245
233
 
246
- **Parameters**:
247
234
 
248
- - `domain`: Domain name (required)
249
235
 
250
236
  ### DNS_updateZoneRecordsV1
251
237
 
@@ -259,7 +245,6 @@ Otherwise existing records will be updated and new records will be added.
259
245
 
260
246
  **Parameters**:
261
247
 
262
- - `domain`: Domain name (required)
263
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.
264
249
  - `zone`: zone property (required)
265
250
 
@@ -275,9 +260,7 @@ refer to the `Update zone records` endpoint.
275
260
  - **Method**: `DELETE`
276
261
  - **Path**: `/api/dns/v1/zones/{domain}`
277
262
 
278
- **Parameters**:
279
263
 
280
- - `domain`: Domain name (required)
281
264
 
282
265
  ### DNS_resetZoneRecordsV1
283
266
 
@@ -288,7 +271,6 @@ This endpoint resets DNS zone to the default records.
288
271
 
289
272
  **Parameters**:
290
273
 
291
- - `domain`: Domain name (required)
292
274
  - `sync`: Determines if operation should be run synchronously
293
275
  - `reset_email_records`: Determines if email records should be reset
294
276
  - `whitelisted_record_types`: Specifies which record types to not reset
@@ -305,7 +287,6 @@ If there is validation error, the response will fail with `422 Validation error`
305
287
 
306
288
  **Parameters**:
307
289
 
308
- - `domain`: Domain name (required)
309
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.
310
291
  - `zone`: zone property (required)
311
292
 
@@ -320,9 +301,69 @@ Endpoint has rate limit of 10 requests per minute.
320
301
 
321
302
  **Parameters**:
322
303
 
323
- - `domain`: domain property (required)
324
- - `tlds`: tlds property (required)
325
- - `with_alternatives`: with_alternatives property
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
+
326
367
 
327
368
  ### domains_getDomainListV1
328
369
 
@@ -333,6 +374,116 @@ This endpoint retrieves a list of all domains associated with your account.
333
374
 
334
375
 
335
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
+
336
487
  ### VPS_getDataCentersListV1
337
488
 
338
489
  This endpoint retrieves a list of all data centers available.
@@ -351,10 +502,7 @@ Only one firewall can be active for a virtual machine at a time.
351
502
  - **Method**: `POST`
352
503
  - **Path**: `/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}`
353
504
 
354
- **Parameters**:
355
505
 
356
- - `firewallId`: Firewall ID (required)
357
- - `virtualMachineId`: Virtual Machine ID (required)
358
506
 
359
507
  ### VPS_deactivateFirewallV1
360
508
 
@@ -363,10 +511,7 @@ This endpoint deactivates a firewall for a specified virtual machine.
363
511
  - **Method**: `POST`
364
512
  - **Path**: `/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}`
365
513
 
366
- **Parameters**:
367
514
 
368
- - `firewallId`: Firewall ID (required)
369
- - `virtualMachineId`: Virtual Machine ID (required)
370
515
 
371
516
  ### VPS_getFirewallV1
372
517
 
@@ -375,9 +520,7 @@ This endpoint retrieves firewall by its ID and rules associated with it.
375
520
  - **Method**: `GET`
376
521
  - **Path**: `/api/vps/v1/firewall/{firewallId}`
377
522
 
378
- **Parameters**:
379
523
 
380
- - `firewallId`: Firewall ID (required)
381
524
 
382
525
  ### VPS_deleteFirewallV1
383
526
 
@@ -388,9 +531,7 @@ Any virtual machine that has this firewall activated will automatically have it
388
531
  - **Method**: `DELETE`
389
532
  - **Path**: `/api/vps/v1/firewall/{firewallId}`
390
533
 
391
- **Parameters**:
392
534
 
393
- - `firewallId`: Firewall ID (required)
394
535
 
395
536
  ### VPS_getFirewallListV1
396
537
 
@@ -399,9 +540,7 @@ This endpoint retrieves a list of all firewalls available.
399
540
  - **Method**: `GET`
400
541
  - **Path**: `/api/vps/v1/firewall`
401
542
 
402
- **Parameters**:
403
543
 
404
- - `page`: Page number
405
544
 
406
545
  ### VPS_createNewFirewallV1
407
546
 
@@ -425,8 +564,6 @@ Any virtual machine that has this firewall activated will loose sync with the fi
425
564
 
426
565
  **Parameters**:
427
566
 
428
- - `firewallId`: Firewall ID (required)
429
- - `ruleId`: Firewall Rule ID (required)
430
567
  - `protocol`: protocol property (required)
431
568
  - `port`: Port or port range, ex: 1024:2048 (required)
432
569
  - `source`: source property (required)
@@ -441,10 +578,7 @@ Any virtual machine that has this firewall activated will loose sync with the fi
441
578
  - **Method**: `DELETE`
442
579
  - **Path**: `/api/vps/v1/firewall/{firewallId}/rules/{ruleId}`
443
580
 
444
- **Parameters**:
445
581
 
446
- - `firewallId`: Firewall ID (required)
447
- - `ruleId`: Firewall Rule ID (required)
448
582
 
449
583
  ### VPS_createFirewallRuleV1
450
584
 
@@ -458,7 +592,6 @@ Any virtual machine that has this firewall activated will loose sync with the fi
458
592
 
459
593
  **Parameters**:
460
594
 
461
- - `firewallId`: Firewall ID (required)
462
595
  - `protocol`: protocol property (required)
463
596
  - `port`: Port or port range, ex: 1024:2048 (required)
464
597
  - `source`: source property (required)
@@ -473,10 +606,7 @@ Firewall can loose sync with virtual machine if the firewall has new rules added
473
606
  - **Method**: `POST`
474
607
  - **Path**: `/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}`
475
608
 
476
- **Parameters**:
477
609
 
478
- - `firewallId`: Firewall ID (required)
479
- - `virtualMachineId`: Virtual Machine ID (required)
480
610
 
481
611
  ### VPS_getPostInstallScriptV1
482
612
 
@@ -485,9 +615,7 @@ This endpoint retrieves post-install script by its ID.
485
615
  - **Method**: `GET`
486
616
  - **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
487
617
 
488
- **Parameters**:
489
618
 
490
- - `postInstallScriptId`: Post-install script ID (required)
491
619
 
492
620
  ### VPS_updatePostInstallScriptV1
493
621
 
@@ -498,7 +626,6 @@ This endpoint updates a specific post-install script.
498
626
 
499
627
  **Parameters**:
500
628
 
501
- - `postInstallScriptId`: Post-install script ID (required)
502
629
  - `name`: Name of the script (required)
503
630
  - `content`: Content of the script (required)
504
631
 
@@ -509,9 +636,7 @@ This endpoint deletes a post-install script from your account.
509
636
  - **Method**: `DELETE`
510
637
  - **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
511
638
 
512
- **Parameters**:
513
639
 
514
- - `postInstallScriptId`: Post-install script ID (required)
515
640
 
516
641
  ### VPS_getPostInstallScriptListV1
517
642
 
@@ -520,9 +645,7 @@ This endpoint retrieves a list of post-install scripts associated with your acco
520
645
  - **Method**: `GET`
521
646
  - **Path**: `/api/vps/v1/post-install-scripts`
522
647
 
523
- **Parameters**:
524
648
 
525
- - `page`: Page number
526
649
 
527
650
  ### VPS_createPostInstallScriptV1
528
651
 
@@ -551,7 +674,6 @@ Multiple keys can be attached to a single virtual machine.
551
674
 
552
675
  **Parameters**:
553
676
 
554
- - `virtualMachineId`: Virtual Machine ID (required)
555
677
  - `ids`: Public Key IDs to attach (required)
556
678
 
557
679
  ### VPS_deleteAPublicKeyV1
@@ -563,9 +685,7 @@ This endpoint deletes a public key from your account.
563
685
  - **Method**: `DELETE`
564
686
  - **Path**: `/api/vps/v1/public-keys/{publicKeyId}`
565
687
 
566
- **Parameters**:
567
688
 
568
- - `publicKeyId`: Public Key ID (required)
569
689
 
570
690
  ### VPS_getPublicKeyListV1
571
691
 
@@ -574,9 +694,7 @@ This endpoint retrieves a list of public keys associated with your account.
574
694
  - **Method**: `GET`
575
695
  - **Path**: `/api/vps/v1/public-keys`
576
696
 
577
- **Parameters**:
578
697
 
579
- - `page`: Page number
580
698
 
581
699
  ### VPS_createNewPublicKeyV1
582
700
 
@@ -598,9 +716,7 @@ This endpoint retrieves details of a specific OS template for virtual machines.
598
716
  - **Method**: `GET`
599
717
  - **Path**: `/api/vps/v1/templates/{templateId}`
600
718
 
601
- **Parameters**:
602
719
 
603
- - `templateId`: Template ID (required)
604
720
 
605
721
  ### VPS_getTemplateListV1
606
722
 
@@ -620,10 +736,7 @@ This endpoint allows you to view detailed information about a particular action,
620
736
  - **Method**: `GET`
621
737
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}`
622
738
 
623
- **Parameters**:
624
739
 
625
- - `virtualMachineId`: Virtual Machine ID (required)
626
- - `actionId`: Action ID (required)
627
740
 
628
741
  ### VPS_getActionListV1
629
742
 
@@ -636,10 +749,7 @@ such as the action name, timestamp, and status.
636
749
  - **Method**: `GET`
637
750
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions`
638
751
 
639
- **Parameters**:
640
752
 
641
- - `virtualMachineId`: Virtual Machine ID (required)
642
- - `page`: Page number
643
753
 
644
754
  ### VPS_getAttachedPublicKeysV1
645
755
 
@@ -648,10 +758,7 @@ This endpoint retrieves a list of public keys attached to a specified virtual ma
648
758
  - **Method**: `GET`
649
759
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys`
650
760
 
651
- **Parameters**:
652
761
 
653
- - `virtualMachineId`: Virtual Machine ID (required)
654
- - `page`: Page number
655
762
 
656
763
  ### VPS_deleteBackupV1
657
764
 
@@ -660,10 +767,7 @@ This endpoint deletes a specified backup for a virtual machine.
660
767
  - **Method**: `DELETE`
661
768
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}`
662
769
 
663
- **Parameters**:
664
770
 
665
- - `virtualMachineId`: Virtual Machine ID (required)
666
- - `backupId`: Backup ID (required)
667
771
 
668
772
  ### VPS_getBackupListV1
669
773
 
@@ -672,10 +776,7 @@ This endpoint retrieves a list of backups for a specified virtual machine.
672
776
  - **Method**: `GET`
673
777
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups`
674
778
 
675
- **Parameters**:
676
779
 
677
- - `page`: Page number
678
- - `virtualMachineId`: Virtual Machine ID (required)
679
780
 
680
781
  ### VPS_restoreBackupV1
681
782
 
@@ -688,10 +789,7 @@ The system will then initiate the restore process, which may take some time depe
688
789
  - **Method**: `POST`
689
790
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore`
690
791
 
691
- **Parameters**:
692
792
 
693
- - `virtualMachineId`: Virtual Machine ID (required)
694
- - `backupId`: Backup ID (required)
695
793
 
696
794
  ### VPS_setHostnameV1
697
795
 
@@ -705,7 +803,6 @@ you need to point your domain A/AAAA records to virtual machine IP as well.
705
803
 
706
804
  **Parameters**:
707
805
 
708
- - `virtualMachineId`: Virtual Machine ID (required)
709
806
  - `hostname`: hostname property (required)
710
807
 
711
808
  ### VPS_resetHostnameV1
@@ -715,9 +812,7 @@ This endpoint resets the hostname and PTR record of a specified virtual machine
715
812
  - **Method**: `DELETE`
716
813
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/hostname`
717
814
 
718
- **Parameters**:
719
815
 
720
- - `virtualMachineId`: Virtual Machine ID (required)
721
816
 
722
817
  ### VPS_getVirtualMachineV1
723
818
 
@@ -726,9 +821,7 @@ This endpoint retrieves detailed information about a specified virtual machine.
726
821
  - **Method**: `GET`
727
822
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}`
728
823
 
729
- **Parameters**:
730
824
 
731
- - `virtualMachineId`: Virtual Machine ID (required)
732
825
 
733
826
  ### VPS_getVirtualMachineListV1
734
827
 
@@ -749,9 +842,7 @@ virtual machine and assessing the effectiveness of the malware scanner.
749
842
  - **Method**: `GET`
750
843
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
751
844
 
752
- **Parameters**:
753
845
 
754
- - `virtualMachineId`: Virtual Machine ID (required)
755
846
 
756
847
  ### VPS_installMonarxV1
757
848
 
@@ -763,9 +854,7 @@ By installing Monarx, users can enhance the security of their virtual machines,
763
854
  - **Method**: `POST`
764
855
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
765
856
 
766
- **Parameters**:
767
857
 
768
- - `virtualMachineId`: Virtual Machine ID (required)
769
858
 
770
859
  ### VPS_uninstallMonarxV1
771
860
 
@@ -775,9 +864,7 @@ If Monarx is not installed, the request will still be processed without any effe
775
864
  - **Method**: `DELETE`
776
865
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
777
866
 
778
- **Parameters**:
779
867
 
780
- - `virtualMachineId`: Virtual Machine ID (required)
781
868
 
782
869
  ### VPS_getMetricsV1
783
870
 
@@ -794,7 +881,6 @@ It includes the following metrics:
794
881
 
795
882
  **Parameters**:
796
883
 
797
- - `virtualMachineId`: Virtual Machine ID (required)
798
884
  - `date_from`: the date-time notation as defined by RFC 3339, section 5.6 (required)
799
885
  - `date_to`: the date-time notation as defined by RFC 3339, section 5.6 (required)
800
886
 
@@ -808,7 +894,6 @@ Be aware, that improper nameserver configuration can lead to the virtual machine
808
894
 
809
895
  **Parameters**:
810
896
 
811
- - `virtualMachineId`: Virtual Machine ID (required)
812
897
  - `ns1`: ns1 property (required)
813
898
  - `ns2`: ns2 property
814
899
 
@@ -819,9 +904,7 @@ This endpoint creates or updates a PTR (Pointer) record for a specified virtual
819
904
  - **Method**: `POST`
820
905
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr`
821
906
 
822
- **Parameters**:
823
907
 
824
- - `virtualMachineId`: Virtual Machine ID (required)
825
908
 
826
909
  ### VPS_deletePTRRecordV1
827
910
 
@@ -832,9 +915,7 @@ Once deleted, reverse DNS lookups to the virtual machine's IP address will no lo
832
915
  - **Method**: `DELETE`
833
916
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr`
834
917
 
835
- **Parameters**:
836
918
 
837
- - `virtualMachineId`: Virtual Machine ID (required)
838
919
 
839
920
  ### VPS_setPanelPasswordV1
840
921
 
@@ -847,7 +928,6 @@ Requirements for the password is the same as in the [recreate virtual machine en
847
928
 
848
929
  **Parameters**:
849
930
 
850
- - `virtualMachineId`: Virtual Machine ID (required)
851
931
  - `password`: Panel password for the virtual machine (required)
852
932
 
853
933
  ### VPS_startRecoveryModeV1
@@ -864,7 +944,6 @@ Virtual machine will boot recovery disk image and original disk image will be mo
864
944
 
865
945
  **Parameters**:
866
946
 
867
- - `virtualMachineId`: Virtual Machine ID (required)
868
947
  - `root_password`: Temporary root password for recovery mode (required)
869
948
 
870
949
  ### VPS_stopRecoveryModeV1
@@ -875,9 +954,7 @@ If virtual machine is not in recovery mode, this operation will fail.
875
954
  - **Method**: `DELETE`
876
955
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recovery`
877
956
 
878
- **Parameters**:
879
957
 
880
- - `virtualMachineId`: Virtual Machine ID (required)
881
958
 
882
959
  ### VPS_recreateVirtualMachineV1
883
960
 
@@ -901,7 +978,6 @@ Requirements for the password are:
901
978
 
902
979
  **Parameters**:
903
980
 
904
- - `virtualMachineId`: Virtual Machine ID (required)
905
981
  - `template_id`: Template ID (required)
906
982
  - `password`: Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response.
907
983
  - `post_install_script_id`: Post-install script ID
@@ -914,9 +990,7 @@ If the virtual machine was stopped, it will be started.
914
990
  - **Method**: `POST`
915
991
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/restart`
916
992
 
917
- **Parameters**:
918
993
 
919
- - `virtualMachineId`: Virtual Machine ID (required)
920
994
 
921
995
  ### VPS_setRootPasswordV1
922
996
 
@@ -928,7 +1002,6 @@ Requirements for the password is the same as in the [recreate virtual machine en
928
1002
 
929
1003
  **Parameters**:
930
1004
 
931
- - `virtualMachineId`: Virtual Machine ID (required)
932
1005
  - `password`: Root password for the virtual machine (required)
933
1006
 
934
1007
  ### VPS_setupNewVirtualMachineV1
@@ -941,7 +1014,6 @@ New virtual machine can be purchased using [`/api/billing/v1/orders`](/#tag/bill
941
1014
 
942
1015
  **Parameters**:
943
1016
 
944
- - `virtualMachineId`: Virtual Machine ID (required)
945
1017
  - `template_id`: Template ID (required)
946
1018
  - `data_center_id`: Data center ID (required)
947
1019
  - `post_install_script_id`: Post-install script ID
@@ -960,9 +1032,7 @@ This endpoint retrieves a snapshot for a specified virtual machine.
960
1032
  - **Method**: `GET`
961
1033
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
962
1034
 
963
- **Parameters**:
964
1035
 
965
- - `virtualMachineId`: Virtual Machine ID (required)
966
1036
 
967
1037
  ### VPS_createSnapshotV1
968
1038
 
@@ -977,9 +1047,7 @@ and testing changes without affecting the current state of the virtual machine.
977
1047
  - **Method**: `POST`
978
1048
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
979
1049
 
980
- **Parameters**:
981
1050
 
982
- - `virtualMachineId`: Virtual Machine ID (required)
983
1051
 
984
1052
  ### VPS_deleteSnapshotV1
985
1053
 
@@ -988,9 +1056,7 @@ This endpoint deletes a snapshot of a specified virtual machine.
988
1056
  - **Method**: `DELETE`
989
1057
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
990
1058
 
991
- **Parameters**:
992
1059
 
993
- - `virtualMachineId`: Virtual Machine ID (required)
994
1060
 
995
1061
  ### VPS_restoreSnapshotV1
996
1062
 
@@ -1000,9 +1066,7 @@ Restoring from a snapshot allows users to revert the virtual machine to that sta
1000
1066
  - **Method**: `POST`
1001
1067
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore`
1002
1068
 
1003
- **Parameters**:
1004
1069
 
1005
- - `virtualMachineId`: Virtual Machine ID (required)
1006
1070
 
1007
1071
  ### VPS_startVirtualMachineV1
1008
1072
 
@@ -1012,9 +1076,7 @@ If the virtual machine is already running, the request will still be processed w
1012
1076
  - **Method**: `POST`
1013
1077
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/start`
1014
1078
 
1015
- **Parameters**:
1016
1079
 
1017
- - `virtualMachineId`: Virtual Machine ID (required)
1018
1080
 
1019
1081
  ### VPS_stopVirtualMachineV1
1020
1082
 
@@ -1024,6 +1086,4 @@ If the virtual machine is already stopped, the request will still be processed w
1024
1086
  - **Method**: `POST`
1025
1087
  - **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/stop`
1026
1088
 
1027
- **Parameters**:
1028
1089
 
1029
- - `virtualMachineId`: Virtual Machine ID (required)