hostinger-api-mcp 1.49.0 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -2
- package/gemini-extension.json +1 -1
- package/package.json +1 -1
- package/server.json +2 -2
- package/src/core/runtime.js +3 -1
- package/src/core/runtime.ts +3 -1
- package/src/core/tools/agency-hosting.js +239 -0
- package/src/core/tools/agency-hosting.ts +239 -0
- package/src/core/tools/all.js +2367 -0
- package/src/core/tools/all.ts +2367 -0
- package/src/core/tools/billing.js +57 -0
- package/src/core/tools/billing.ts +57 -0
- package/src/core/tools/dns.js +50 -0
- package/src/core/tools/dns.ts +50 -0
- package/src/core/tools/domains.js +255 -0
- package/src/core/tools/domains.ts +255 -0
- package/src/core/tools/ecommerce.js +180 -0
- package/src/core/tools/ecommerce.ts +180 -0
- package/src/core/tools/horizons.js +12 -0
- package/src/core/tools/horizons.ts +12 -0
- package/src/core/tools/hosting.js +365 -0
- package/src/core/tools/hosting.ts +365 -0
- package/src/core/tools/mail.js +239 -0
- package/src/core/tools/mail.ts +239 -0
- package/src/core/tools/reach.js +306 -0
- package/src/core/tools/reach.ts +306 -0
- package/src/core/tools/vps.js +432 -0
- package/src/core/tools/vps.ts +432 -0
- package/src/core/tools/wordpress.js +232 -0
- package/src/core/tools/wordpress.ts +232 -0
- package/src/servers/agency-hosting.js +1 -1
- package/src/servers/agency-hosting.ts +1 -1
- package/src/servers/all.js +1 -1
- package/src/servers/all.ts +1 -1
- package/src/servers/billing.js +1 -1
- package/src/servers/billing.ts +1 -1
- package/src/servers/dns.js +1 -1
- package/src/servers/dns.ts +1 -1
- package/src/servers/domains.js +1 -1
- package/src/servers/domains.ts +1 -1
- package/src/servers/ecommerce.js +1 -1
- package/src/servers/ecommerce.ts +1 -1
- package/src/servers/horizons.js +1 -1
- package/src/servers/horizons.ts +1 -1
- package/src/servers/hosting.js +1 -1
- package/src/servers/hosting.ts +1 -1
- package/src/servers/mail.js +1 -1
- package/src/servers/mail.ts +1 -1
- package/src/servers/reach.js +1 -1
- package/src/servers/reach.ts +1 -1
- package/src/servers/vps.js +1 -1
- package/src/servers/vps.ts +1 -1
- package/src/servers/wordpress.js +1 -1
- package/src/servers/wordpress.ts +1 -1
- package/types.d.ts +25 -0
package/src/core/tools/vps.js
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
export default [
|
|
3
3
|
{
|
|
4
4
|
"name": "VPS_getDataCenterListV1",
|
|
5
|
+
"title": "Get data center list",
|
|
6
|
+
"annotations": {
|
|
7
|
+
"title": "Get data center list",
|
|
8
|
+
"readOnlyHint": true,
|
|
9
|
+
"destructiveHint": false
|
|
10
|
+
},
|
|
5
11
|
"description": "Retrieve all available data centers.\n\nUse this endpoint to view location options before deploying VPS instances.",
|
|
6
12
|
"method": "GET",
|
|
7
13
|
"path": "/api/vps/v1/data-centers",
|
|
@@ -19,6 +25,12 @@ export default [
|
|
|
19
25
|
},
|
|
20
26
|
{
|
|
21
27
|
"name": "VPS_getProjectContainersV1",
|
|
28
|
+
"title": "Get project containers",
|
|
29
|
+
"annotations": {
|
|
30
|
+
"title": "Get project containers",
|
|
31
|
+
"readOnlyHint": true,
|
|
32
|
+
"destructiveHint": false
|
|
33
|
+
},
|
|
22
34
|
"description": "Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine. \n\nThis endpoint returns detailed information about each container including\ntheir current status, port mappings, and runtime configuration.\n\nUse this to monitor the health and state of all services within your Docker Compose project.",
|
|
23
35
|
"method": "GET",
|
|
24
36
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers",
|
|
@@ -48,6 +60,12 @@ export default [
|
|
|
48
60
|
},
|
|
49
61
|
{
|
|
50
62
|
"name": "VPS_getProjectContentsV1",
|
|
63
|
+
"title": "Get project contents",
|
|
64
|
+
"annotations": {
|
|
65
|
+
"title": "Get project contents",
|
|
66
|
+
"readOnlyHint": true,
|
|
67
|
+
"destructiveHint": false
|
|
68
|
+
},
|
|
51
69
|
"description": "Retrieves the complete project information including the docker-compose.yml\nfile contents, project metadata, and current deployment status.\n\nThis endpoint provides the full configuration and state details of a specific Docker Compose project. \n\nUse this to inspect project settings, review the compose file, or check the overall project health.",
|
|
52
70
|
"method": "GET",
|
|
53
71
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}",
|
|
@@ -77,6 +95,13 @@ export default [
|
|
|
77
95
|
},
|
|
78
96
|
{
|
|
79
97
|
"name": "VPS_deleteProjectV1",
|
|
98
|
+
"title": "Delete project",
|
|
99
|
+
"annotations": {
|
|
100
|
+
"title": "Delete project",
|
|
101
|
+
"readOnlyHint": false,
|
|
102
|
+
"destructiveHint": true,
|
|
103
|
+
"idempotentHint": true
|
|
104
|
+
},
|
|
80
105
|
"description": "Completely removes a Docker Compose project from the virtual machine, stopping all containers and cleaning up \nassociated resources including networks, volumes, and images. \n\nThis operation is irreversible and will delete all project data. \n\nUse this when you want to permanently remove a project and free up system resources.",
|
|
81
106
|
"method": "DELETE",
|
|
82
107
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down",
|
|
@@ -106,6 +131,12 @@ export default [
|
|
|
106
131
|
},
|
|
107
132
|
{
|
|
108
133
|
"name": "VPS_getProjectListV1",
|
|
134
|
+
"title": "Get project list",
|
|
135
|
+
"annotations": {
|
|
136
|
+
"title": "Get project list",
|
|
137
|
+
"readOnlyHint": true,
|
|
138
|
+
"destructiveHint": false
|
|
139
|
+
},
|
|
109
140
|
"description": "Retrieves a list of all Docker Compose projects currently deployed on the virtual machine. \n\nThis endpoint returns basic information about each project including name,\nstatus, file path and list of containers with details about their names,\nimage, status, health and ports. Container stats are omitted in this\nendpoint. If you need to get detailed information about container with\nstats included, use the `Get project containers` endpoint.\n\nUse this to get an overview of all Docker projects on your VPS instance.",
|
|
110
141
|
"method": "GET",
|
|
111
142
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker",
|
|
@@ -130,6 +161,12 @@ export default [
|
|
|
130
161
|
},
|
|
131
162
|
{
|
|
132
163
|
"name": "VPS_createNewProjectV1",
|
|
164
|
+
"title": "Create new project",
|
|
165
|
+
"annotations": {
|
|
166
|
+
"title": "Create new project",
|
|
167
|
+
"readOnlyHint": false,
|
|
168
|
+
"destructiveHint": false
|
|
169
|
+
},
|
|
133
170
|
"description": "Deploy new project from docker-compose.yaml contents or download contents from URL. \n\nURL can be Github repository url in format https://github.com/[user]/[repo]\nand it will be automatically resolved to docker-compose.yaml file in\nmaster branch. Any other URL provided must return docker-compose.yaml\nfile contents.\n\nIf project with the same name already exists, existing project will be replaced.",
|
|
134
171
|
"method": "POST",
|
|
135
172
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker",
|
|
@@ -168,6 +205,12 @@ export default [
|
|
|
168
205
|
},
|
|
169
206
|
{
|
|
170
207
|
"name": "VPS_getProjectLogsV1",
|
|
208
|
+
"title": "Get project logs",
|
|
209
|
+
"annotations": {
|
|
210
|
+
"title": "Get project logs",
|
|
211
|
+
"readOnlyHint": true,
|
|
212
|
+
"destructiveHint": false
|
|
213
|
+
},
|
|
171
214
|
"description": "Retrieves aggregated log entries from all services within a Docker Compose project. \n\nThis endpoint returns recent log output from each container, organized by service name with timestamps. \nThe response contains the last 300 log entries across all services. \n\nUse this for debugging, monitoring application behavior, and\ntroubleshooting issues across your entire project stack.",
|
|
172
215
|
"method": "GET",
|
|
173
216
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs",
|
|
@@ -197,6 +240,12 @@ export default [
|
|
|
197
240
|
},
|
|
198
241
|
{
|
|
199
242
|
"name": "VPS_restartProjectV1",
|
|
243
|
+
"title": "Restart project",
|
|
244
|
+
"annotations": {
|
|
245
|
+
"title": "Restart project",
|
|
246
|
+
"readOnlyHint": false,
|
|
247
|
+
"destructiveHint": false
|
|
248
|
+
},
|
|
200
249
|
"description": "Restarts all services in a Docker Compose project by stopping and starting\ncontainers in the correct dependency order.\n\nThis operation preserves data volumes and network configurations while refreshing the running containers. \n\nUse this to apply configuration changes or recover from service failures.",
|
|
201
250
|
"method": "POST",
|
|
202
251
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart",
|
|
@@ -226,6 +275,12 @@ export default [
|
|
|
226
275
|
},
|
|
227
276
|
{
|
|
228
277
|
"name": "VPS_startProjectV1",
|
|
278
|
+
"title": "Start project",
|
|
279
|
+
"annotations": {
|
|
280
|
+
"title": "Start project",
|
|
281
|
+
"readOnlyHint": false,
|
|
282
|
+
"destructiveHint": false
|
|
283
|
+
},
|
|
229
284
|
"description": "Starts all services in a Docker Compose project that are currently stopped. \n\nThis operation brings up containers in the correct dependency order as defined in the compose file. \n\nUse this to resume a project that was previously stopped or to start services after a system reboot.",
|
|
230
285
|
"method": "POST",
|
|
231
286
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start",
|
|
@@ -255,6 +310,12 @@ export default [
|
|
|
255
310
|
},
|
|
256
311
|
{
|
|
257
312
|
"name": "VPS_stopProjectV1",
|
|
313
|
+
"title": "Stop project",
|
|
314
|
+
"annotations": {
|
|
315
|
+
"title": "Stop project",
|
|
316
|
+
"readOnlyHint": false,
|
|
317
|
+
"destructiveHint": true
|
|
318
|
+
},
|
|
258
319
|
"description": "Stops all running services in a Docker Compose project while preserving\ncontainer configurations and data volumes.\n\nThis operation gracefully shuts down containers in reverse dependency order. \n\nUse this to temporarily halt a project without removing data or configurations.",
|
|
259
320
|
"method": "POST",
|
|
260
321
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop",
|
|
@@ -284,6 +345,12 @@ export default [
|
|
|
284
345
|
},
|
|
285
346
|
{
|
|
286
347
|
"name": "VPS_updateProjectV1",
|
|
348
|
+
"title": "Update project",
|
|
349
|
+
"annotations": {
|
|
350
|
+
"title": "Update project",
|
|
351
|
+
"readOnlyHint": false,
|
|
352
|
+
"destructiveHint": false
|
|
353
|
+
},
|
|
287
354
|
"description": "Updates a Docker Compose project by pulling the latest image versions and\nrecreating containers with new configurations.\n\nThis operation preserves data volumes while applying changes from the compose file. \n\nUse this to deploy application updates, apply configuration changes, or\nrefresh container images to their latest versions.",
|
|
288
355
|
"method": "POST",
|
|
289
356
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update",
|
|
@@ -313,6 +380,12 @@ export default [
|
|
|
313
380
|
},
|
|
314
381
|
{
|
|
315
382
|
"name": "VPS_activateFirewallV1",
|
|
383
|
+
"title": "Activate firewall",
|
|
384
|
+
"annotations": {
|
|
385
|
+
"title": "Activate firewall",
|
|
386
|
+
"readOnlyHint": false,
|
|
387
|
+
"destructiveHint": false
|
|
388
|
+
},
|
|
316
389
|
"description": "Activate a firewall for a specified virtual machine.\n\nOnly one firewall can be active for a virtual machine at a time.\n\nUse this endpoint to apply firewall rules to VPS instances.",
|
|
317
390
|
"method": "POST",
|
|
318
391
|
"path": "/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}",
|
|
@@ -342,6 +415,12 @@ export default [
|
|
|
342
415
|
},
|
|
343
416
|
{
|
|
344
417
|
"name": "VPS_deactivateFirewallV1",
|
|
418
|
+
"title": "Deactivate firewall",
|
|
419
|
+
"annotations": {
|
|
420
|
+
"title": "Deactivate firewall",
|
|
421
|
+
"readOnlyHint": false,
|
|
422
|
+
"destructiveHint": false
|
|
423
|
+
},
|
|
345
424
|
"description": "Deactivate a firewall for a specified virtual machine.\n\nUse this endpoint to remove firewall protection from VPS instances.",
|
|
346
425
|
"method": "POST",
|
|
347
426
|
"path": "/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}",
|
|
@@ -371,6 +450,12 @@ export default [
|
|
|
371
450
|
},
|
|
372
451
|
{
|
|
373
452
|
"name": "VPS_getFirewallDetailsV1",
|
|
453
|
+
"title": "Get firewall details",
|
|
454
|
+
"annotations": {
|
|
455
|
+
"title": "Get firewall details",
|
|
456
|
+
"readOnlyHint": true,
|
|
457
|
+
"destructiveHint": false
|
|
458
|
+
},
|
|
374
459
|
"description": "Retrieve firewall by its ID and rules associated with it.\n\nUse this endpoint to view specific firewall configuration and rules.",
|
|
375
460
|
"method": "GET",
|
|
376
461
|
"path": "/api/vps/v1/firewall/{firewallId}",
|
|
@@ -395,6 +480,13 @@ export default [
|
|
|
395
480
|
},
|
|
396
481
|
{
|
|
397
482
|
"name": "VPS_deleteFirewallV1",
|
|
483
|
+
"title": "Delete firewall",
|
|
484
|
+
"annotations": {
|
|
485
|
+
"title": "Delete firewall",
|
|
486
|
+
"readOnlyHint": false,
|
|
487
|
+
"destructiveHint": true,
|
|
488
|
+
"idempotentHint": true
|
|
489
|
+
},
|
|
398
490
|
"description": "Delete a specified firewall.\n\nAny virtual machine that has this firewall activated will automatically have it deactivated.\n\nUse this endpoint to remove unused firewall configurations.",
|
|
399
491
|
"method": "DELETE",
|
|
400
492
|
"path": "/api/vps/v1/firewall/{firewallId}",
|
|
@@ -419,6 +511,12 @@ export default [
|
|
|
419
511
|
},
|
|
420
512
|
{
|
|
421
513
|
"name": "VPS_getFirewallListV1",
|
|
514
|
+
"title": "Get firewall list",
|
|
515
|
+
"annotations": {
|
|
516
|
+
"title": "Get firewall list",
|
|
517
|
+
"readOnlyHint": true,
|
|
518
|
+
"destructiveHint": false
|
|
519
|
+
},
|
|
422
520
|
"description": "Retrieve all available firewalls.\n\nUse this endpoint to view existing firewall configurations.",
|
|
423
521
|
"method": "GET",
|
|
424
522
|
"path": "/api/vps/v1/firewall",
|
|
@@ -441,6 +539,12 @@ export default [
|
|
|
441
539
|
},
|
|
442
540
|
{
|
|
443
541
|
"name": "VPS_createNewFirewallV1",
|
|
542
|
+
"title": "Create new firewall",
|
|
543
|
+
"annotations": {
|
|
544
|
+
"title": "Create new firewall",
|
|
545
|
+
"readOnlyHint": false,
|
|
546
|
+
"destructiveHint": false
|
|
547
|
+
},
|
|
444
548
|
"description": "Create a new firewall.\n\nUse this endpoint to set up new firewall configurations for VPS security.",
|
|
445
549
|
"method": "POST",
|
|
446
550
|
"path": "/api/vps/v1/firewall",
|
|
@@ -465,6 +569,13 @@ export default [
|
|
|
465
569
|
},
|
|
466
570
|
{
|
|
467
571
|
"name": "VPS_updateFirewallRuleV1",
|
|
572
|
+
"title": "Update firewall rule",
|
|
573
|
+
"annotations": {
|
|
574
|
+
"title": "Update firewall rule",
|
|
575
|
+
"readOnlyHint": false,
|
|
576
|
+
"destructiveHint": true,
|
|
577
|
+
"idempotentHint": true
|
|
578
|
+
},
|
|
468
579
|
"description": "Update a specific firewall rule from a specified firewall.\n\nAny virtual machine that has this firewall activated will lose sync with the firewall\nand will have to be synced again manually.\n\nUse this endpoint to modify existing firewall rules.",
|
|
469
580
|
"method": "PUT",
|
|
470
581
|
"path": "/api/vps/v1/firewall/{firewallId}/rules/{ruleId}",
|
|
@@ -533,6 +644,13 @@ export default [
|
|
|
533
644
|
},
|
|
534
645
|
{
|
|
535
646
|
"name": "VPS_deleteFirewallRuleV1",
|
|
647
|
+
"title": "Delete firewall rule",
|
|
648
|
+
"annotations": {
|
|
649
|
+
"title": "Delete firewall rule",
|
|
650
|
+
"readOnlyHint": false,
|
|
651
|
+
"destructiveHint": true,
|
|
652
|
+
"idempotentHint": true
|
|
653
|
+
},
|
|
536
654
|
"description": "Delete a specific firewall rule from a specified firewall.\n\nAny virtual machine that has this firewall activated will lose sync with the firewall\nand will have to be synced again manually.\n\nUse this endpoint to remove specific firewall rules.",
|
|
537
655
|
"method": "DELETE",
|
|
538
656
|
"path": "/api/vps/v1/firewall/{firewallId}/rules/{ruleId}",
|
|
@@ -560,8 +678,58 @@ export default [
|
|
|
560
678
|
],
|
|
561
679
|
"group": "vps"
|
|
562
680
|
},
|
|
681
|
+
{
|
|
682
|
+
"name": "VPS_replaceAllFirewallRulesInGroupV1",
|
|
683
|
+
"title": "Replace all firewall rules in group",
|
|
684
|
+
"annotations": {
|
|
685
|
+
"title": "Replace all firewall rules in group",
|
|
686
|
+
"readOnlyHint": false,
|
|
687
|
+
"destructiveHint": true,
|
|
688
|
+
"idempotentHint": true
|
|
689
|
+
},
|
|
690
|
+
"description": "Replaces all firewall rules within a specified firewall group with the provided set of rules\nin a single atomic operation, instead of creating or deleting rules one by one.\n\nAny virtual machine using this firewall group will need to be synchronized after replacing rules;\npass the \"sync\" query parameter to trigger synchronization immediately.",
|
|
691
|
+
"method": "PUT",
|
|
692
|
+
"path": "/api/vps/v1/firewall/{firewallId}/rules",
|
|
693
|
+
"inputSchema": {
|
|
694
|
+
"type": "object",
|
|
695
|
+
"properties": {
|
|
696
|
+
"firewallId": {
|
|
697
|
+
"type": "integer",
|
|
698
|
+
"description": "Firewall ID"
|
|
699
|
+
},
|
|
700
|
+
"sync": {
|
|
701
|
+
"type": "boolean",
|
|
702
|
+
"description": "Synchronize the firewall group to all its virtual machines after replacing the rules"
|
|
703
|
+
},
|
|
704
|
+
"rules": {
|
|
705
|
+
"type": "array",
|
|
706
|
+
"description": "The complete set of firewall rules that atomically replaces all existing rules in the group",
|
|
707
|
+
"items": {
|
|
708
|
+
"type": "string",
|
|
709
|
+
"description": "rules parameter"
|
|
710
|
+
}
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
"required": [
|
|
714
|
+
"firewallId",
|
|
715
|
+
"rules"
|
|
716
|
+
]
|
|
717
|
+
},
|
|
718
|
+
"security": [
|
|
719
|
+
{
|
|
720
|
+
"apiToken": []
|
|
721
|
+
}
|
|
722
|
+
],
|
|
723
|
+
"group": "vps"
|
|
724
|
+
},
|
|
563
725
|
{
|
|
564
726
|
"name": "VPS_createFirewallRuleV1",
|
|
727
|
+
"title": "Create firewall rule",
|
|
728
|
+
"annotations": {
|
|
729
|
+
"title": "Create firewall rule",
|
|
730
|
+
"readOnlyHint": false,
|
|
731
|
+
"destructiveHint": false
|
|
732
|
+
},
|
|
565
733
|
"description": "Create new firewall rule for a specified firewall.\n\nBy default, the firewall drops all incoming traffic,\nwhich means you must add accept rules for all ports you want to use.\n\nAny virtual machine that has this firewall activated will lose sync with the firewall\nand will have to be synced again manually.\n\nUse this endpoint to add new security rules to firewalls.",
|
|
566
734
|
"method": "POST",
|
|
567
735
|
"path": "/api/vps/v1/firewall/{firewallId}/rules",
|
|
@@ -625,6 +793,12 @@ export default [
|
|
|
625
793
|
},
|
|
626
794
|
{
|
|
627
795
|
"name": "VPS_syncFirewallV1",
|
|
796
|
+
"title": "Sync firewall",
|
|
797
|
+
"annotations": {
|
|
798
|
+
"title": "Sync firewall",
|
|
799
|
+
"readOnlyHint": false,
|
|
800
|
+
"destructiveHint": false
|
|
801
|
+
},
|
|
628
802
|
"description": "Sync a firewall for a specified virtual machine.\n\nFirewall can lose sync with virtual machine if the firewall has new rules added, removed or updated.\n\nUse this endpoint to apply updated firewall rules to VPS instances.",
|
|
629
803
|
"method": "POST",
|
|
630
804
|
"path": "/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}",
|
|
@@ -654,6 +828,12 @@ export default [
|
|
|
654
828
|
},
|
|
655
829
|
{
|
|
656
830
|
"name": "VPS_getPostInstallScriptV1",
|
|
831
|
+
"title": "Get post-install script",
|
|
832
|
+
"annotations": {
|
|
833
|
+
"title": "Get post-install script",
|
|
834
|
+
"readOnlyHint": true,
|
|
835
|
+
"destructiveHint": false
|
|
836
|
+
},
|
|
657
837
|
"description": "Retrieve post-install script by its ID.\n\nUse this endpoint to view specific automation script details.",
|
|
658
838
|
"method": "GET",
|
|
659
839
|
"path": "/api/vps/v1/post-install-scripts/{postInstallScriptId}",
|
|
@@ -678,6 +858,13 @@ export default [
|
|
|
678
858
|
},
|
|
679
859
|
{
|
|
680
860
|
"name": "VPS_updatePostInstallScriptV1",
|
|
861
|
+
"title": "Update post-install script",
|
|
862
|
+
"annotations": {
|
|
863
|
+
"title": "Update post-install script",
|
|
864
|
+
"readOnlyHint": false,
|
|
865
|
+
"destructiveHint": true,
|
|
866
|
+
"idempotentHint": true
|
|
867
|
+
},
|
|
681
868
|
"description": "Update a specific post-install script.\n\nUse this endpoint to modify existing automation scripts.",
|
|
682
869
|
"method": "PUT",
|
|
683
870
|
"path": "/api/vps/v1/post-install-scripts/{postInstallScriptId}",
|
|
@@ -712,6 +899,13 @@ export default [
|
|
|
712
899
|
},
|
|
713
900
|
{
|
|
714
901
|
"name": "VPS_deletePostInstallScriptV1",
|
|
902
|
+
"title": "Delete post-install script",
|
|
903
|
+
"annotations": {
|
|
904
|
+
"title": "Delete post-install script",
|
|
905
|
+
"readOnlyHint": false,
|
|
906
|
+
"destructiveHint": true,
|
|
907
|
+
"idempotentHint": true
|
|
908
|
+
},
|
|
715
909
|
"description": "Delete a post-install script from your account.\n \nUse this endpoint to remove unused automation scripts.",
|
|
716
910
|
"method": "DELETE",
|
|
717
911
|
"path": "/api/vps/v1/post-install-scripts/{postInstallScriptId}",
|
|
@@ -736,6 +930,12 @@ export default [
|
|
|
736
930
|
},
|
|
737
931
|
{
|
|
738
932
|
"name": "VPS_getPostInstallScriptsV1",
|
|
933
|
+
"title": "Get post-install scripts",
|
|
934
|
+
"annotations": {
|
|
935
|
+
"title": "Get post-install scripts",
|
|
936
|
+
"readOnlyHint": true,
|
|
937
|
+
"destructiveHint": false
|
|
938
|
+
},
|
|
739
939
|
"description": "Retrieve post-install scripts associated with your account.\n\nUse this endpoint to view available automation scripts for VPS deployment.",
|
|
740
940
|
"method": "GET",
|
|
741
941
|
"path": "/api/vps/v1/post-install-scripts",
|
|
@@ -758,6 +958,12 @@ export default [
|
|
|
758
958
|
},
|
|
759
959
|
{
|
|
760
960
|
"name": "VPS_createPostInstallScriptV1",
|
|
961
|
+
"title": "Create post-install script",
|
|
962
|
+
"annotations": {
|
|
963
|
+
"title": "Create post-install script",
|
|
964
|
+
"readOnlyHint": false,
|
|
965
|
+
"destructiveHint": false
|
|
966
|
+
},
|
|
761
967
|
"description": "Add a new post-install script to your account, which can then be used after virtual machine installation.\n\nThe script contents will be saved to the file `/post_install` with executable attribute set\nand will be executed once virtual machine is installed.\nThe output of the script will be redirected to `/post_install.log`. Maximum script size is 48KB.\n\nUse this endpoint to create automation scripts for VPS setup tasks.",
|
|
762
968
|
"method": "POST",
|
|
763
969
|
"path": "/api/vps/v1/post-install-scripts",
|
|
@@ -787,6 +993,12 @@ export default [
|
|
|
787
993
|
},
|
|
788
994
|
{
|
|
789
995
|
"name": "VPS_attachPublicKeyV1",
|
|
996
|
+
"title": "Attach public key",
|
|
997
|
+
"annotations": {
|
|
998
|
+
"title": "Attach public key",
|
|
999
|
+
"readOnlyHint": false,
|
|
1000
|
+
"destructiveHint": false
|
|
1001
|
+
},
|
|
790
1002
|
"description": "Attach existing public keys from your account to a specified virtual machine.\n\nMultiple keys can be attached to a single virtual machine.\n\nUse this endpoint to enable SSH key authentication for VPS instances.",
|
|
791
1003
|
"method": "POST",
|
|
792
1004
|
"path": "/api/vps/v1/public-keys/attach/{virtualMachineId}",
|
|
@@ -820,6 +1032,13 @@ export default [
|
|
|
820
1032
|
},
|
|
821
1033
|
{
|
|
822
1034
|
"name": "VPS_deletePublicKeyV1",
|
|
1035
|
+
"title": "Delete public key",
|
|
1036
|
+
"annotations": {
|
|
1037
|
+
"title": "Delete public key",
|
|
1038
|
+
"readOnlyHint": false,
|
|
1039
|
+
"destructiveHint": true,
|
|
1040
|
+
"idempotentHint": true
|
|
1041
|
+
},
|
|
823
1042
|
"description": "Delete a public key from your account. \n\n**Deleting public key from account does not remove it from virtual machine** \n \nUse this endpoint to remove unused SSH keys from account.",
|
|
824
1043
|
"method": "DELETE",
|
|
825
1044
|
"path": "/api/vps/v1/public-keys/{publicKeyId}",
|
|
@@ -844,6 +1063,12 @@ export default [
|
|
|
844
1063
|
},
|
|
845
1064
|
{
|
|
846
1065
|
"name": "VPS_getPublicKeysV1",
|
|
1066
|
+
"title": "Get public keys",
|
|
1067
|
+
"annotations": {
|
|
1068
|
+
"title": "Get public keys",
|
|
1069
|
+
"readOnlyHint": true,
|
|
1070
|
+
"destructiveHint": false
|
|
1071
|
+
},
|
|
847
1072
|
"description": "Retrieve public keys associated with your account.\n\nUse this endpoint to view available SSH keys for VPS authentication.",
|
|
848
1073
|
"method": "GET",
|
|
849
1074
|
"path": "/api/vps/v1/public-keys",
|
|
@@ -866,6 +1091,12 @@ export default [
|
|
|
866
1091
|
},
|
|
867
1092
|
{
|
|
868
1093
|
"name": "VPS_createPublicKeyV1",
|
|
1094
|
+
"title": "Create public key",
|
|
1095
|
+
"annotations": {
|
|
1096
|
+
"title": "Create public key",
|
|
1097
|
+
"readOnlyHint": false,
|
|
1098
|
+
"destructiveHint": false
|
|
1099
|
+
},
|
|
869
1100
|
"description": "Add a new public key to your account.\n\nUse this endpoint to register SSH keys for VPS authentication.",
|
|
870
1101
|
"method": "POST",
|
|
871
1102
|
"path": "/api/vps/v1/public-keys",
|
|
@@ -895,6 +1126,12 @@ export default [
|
|
|
895
1126
|
},
|
|
896
1127
|
{
|
|
897
1128
|
"name": "VPS_getTemplateDetailsV1",
|
|
1129
|
+
"title": "Get template details",
|
|
1130
|
+
"annotations": {
|
|
1131
|
+
"title": "Get template details",
|
|
1132
|
+
"readOnlyHint": true,
|
|
1133
|
+
"destructiveHint": false
|
|
1134
|
+
},
|
|
898
1135
|
"description": "Retrieve detailed information about a specific OS template for virtual machines.\n\nUse this endpoint to view specific template specifications before deployment.",
|
|
899
1136
|
"method": "GET",
|
|
900
1137
|
"path": "/api/vps/v1/templates/{templateId}",
|
|
@@ -919,6 +1156,12 @@ export default [
|
|
|
919
1156
|
},
|
|
920
1157
|
{
|
|
921
1158
|
"name": "VPS_getTemplatesV1",
|
|
1159
|
+
"title": "Get templates",
|
|
1160
|
+
"annotations": {
|
|
1161
|
+
"title": "Get templates",
|
|
1162
|
+
"readOnlyHint": true,
|
|
1163
|
+
"destructiveHint": false
|
|
1164
|
+
},
|
|
922
1165
|
"description": "Retrieve available OS templates for virtual machines.\n\nUse this endpoint to view operating system options before creating or recreating VPS instances.",
|
|
923
1166
|
"method": "GET",
|
|
924
1167
|
"path": "/api/vps/v1/templates",
|
|
@@ -936,6 +1179,12 @@ export default [
|
|
|
936
1179
|
},
|
|
937
1180
|
{
|
|
938
1181
|
"name": "VPS_getActionDetailsV1",
|
|
1182
|
+
"title": "Get action details",
|
|
1183
|
+
"annotations": {
|
|
1184
|
+
"title": "Get action details",
|
|
1185
|
+
"readOnlyHint": true,
|
|
1186
|
+
"destructiveHint": false
|
|
1187
|
+
},
|
|
939
1188
|
"description": "Retrieve detailed information about a specific action performed on a specified virtual machine.\n\nUse this endpoint to monitor specific VPS operation status and details.",
|
|
940
1189
|
"method": "GET",
|
|
941
1190
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}",
|
|
@@ -965,6 +1214,12 @@ export default [
|
|
|
965
1214
|
},
|
|
966
1215
|
{
|
|
967
1216
|
"name": "VPS_getActionsV1",
|
|
1217
|
+
"title": "Get actions",
|
|
1218
|
+
"annotations": {
|
|
1219
|
+
"title": "Get actions",
|
|
1220
|
+
"readOnlyHint": true,
|
|
1221
|
+
"destructiveHint": false
|
|
1222
|
+
},
|
|
968
1223
|
"description": "Retrieve actions performed on a specified virtual machine.\n\nActions are operations or events that have been executed on the virtual\nmachine, such as starting, stopping, or modifying the machine. This endpoint\nallows you to view the history of these actions, providing details about\neach action, such as the action name, timestamp, and status.\n\nUse this endpoint to view VPS operation history and troubleshoot issues.",
|
|
969
1224
|
"method": "GET",
|
|
970
1225
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/actions",
|
|
@@ -993,6 +1248,12 @@ export default [
|
|
|
993
1248
|
},
|
|
994
1249
|
{
|
|
995
1250
|
"name": "VPS_getAttachedPublicKeysV1",
|
|
1251
|
+
"title": "Get attached public keys",
|
|
1252
|
+
"annotations": {
|
|
1253
|
+
"title": "Get attached public keys",
|
|
1254
|
+
"readOnlyHint": true,
|
|
1255
|
+
"destructiveHint": false
|
|
1256
|
+
},
|
|
996
1257
|
"description": "Retrieve public keys attached to a specified virtual machine.\n\nUse this endpoint to view SSH keys configured for specific VPS instances.",
|
|
997
1258
|
"method": "GET",
|
|
998
1259
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys",
|
|
@@ -1021,6 +1282,12 @@ export default [
|
|
|
1021
1282
|
},
|
|
1022
1283
|
{
|
|
1023
1284
|
"name": "VPS_getBackupsV1",
|
|
1285
|
+
"title": "Get backups",
|
|
1286
|
+
"annotations": {
|
|
1287
|
+
"title": "Get backups",
|
|
1288
|
+
"readOnlyHint": true,
|
|
1289
|
+
"destructiveHint": false
|
|
1290
|
+
},
|
|
1024
1291
|
"description": "Retrieve backups for a specified virtual machine.\n\nUse this endpoint to view available backup points for VPS data recovery.",
|
|
1025
1292
|
"method": "GET",
|
|
1026
1293
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/backups",
|
|
@@ -1049,6 +1316,12 @@ export default [
|
|
|
1049
1316
|
},
|
|
1050
1317
|
{
|
|
1051
1318
|
"name": "VPS_restoreBackupV1",
|
|
1319
|
+
"title": "Restore backup",
|
|
1320
|
+
"annotations": {
|
|
1321
|
+
"title": "Restore backup",
|
|
1322
|
+
"readOnlyHint": false,
|
|
1323
|
+
"destructiveHint": true
|
|
1324
|
+
},
|
|
1052
1325
|
"description": "Restore a backup for a specified virtual machine.\n\nThe system will then initiate the restore process, which may take some time depending on the size of the backup.\n\n**All data on the virtual machine will be overwritten with the data from the backup.**\n\nUse this endpoint to recover VPS data from backup points.",
|
|
1053
1326
|
"method": "POST",
|
|
1054
1327
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore",
|
|
@@ -1078,6 +1351,13 @@ export default [
|
|
|
1078
1351
|
},
|
|
1079
1352
|
{
|
|
1080
1353
|
"name": "VPS_setHostnameV1",
|
|
1354
|
+
"title": "Set hostname",
|
|
1355
|
+
"annotations": {
|
|
1356
|
+
"title": "Set hostname",
|
|
1357
|
+
"readOnlyHint": false,
|
|
1358
|
+
"destructiveHint": true,
|
|
1359
|
+
"idempotentHint": true
|
|
1360
|
+
},
|
|
1081
1361
|
"description": "Set hostname for a specified virtual machine.\n\nChanging hostname does not update PTR record automatically.\nIf you want your virtual machine to be reachable by a hostname, \nyou need to point your domain A/AAAA records to virtual machine IP as well.\n\nUse this endpoint to configure custom hostnames for VPS instances.",
|
|
1082
1362
|
"method": "PUT",
|
|
1083
1363
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/hostname",
|
|
@@ -1107,6 +1387,13 @@ export default [
|
|
|
1107
1387
|
},
|
|
1108
1388
|
{
|
|
1109
1389
|
"name": "VPS_resetHostnameV1",
|
|
1390
|
+
"title": "Reset hostname",
|
|
1391
|
+
"annotations": {
|
|
1392
|
+
"title": "Reset hostname",
|
|
1393
|
+
"readOnlyHint": false,
|
|
1394
|
+
"destructiveHint": true,
|
|
1395
|
+
"idempotentHint": true
|
|
1396
|
+
},
|
|
1110
1397
|
"description": "Reset hostname and PTR record of a specified virtual machine to default value.\n\nUse this endpoint to restore default hostname configuration for VPS instances.",
|
|
1111
1398
|
"method": "DELETE",
|
|
1112
1399
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/hostname",
|
|
@@ -1131,6 +1418,12 @@ export default [
|
|
|
1131
1418
|
},
|
|
1132
1419
|
{
|
|
1133
1420
|
"name": "VPS_getVirtualMachineDetailsV1",
|
|
1421
|
+
"title": "Get virtual machine details",
|
|
1422
|
+
"annotations": {
|
|
1423
|
+
"title": "Get virtual machine details",
|
|
1424
|
+
"readOnlyHint": true,
|
|
1425
|
+
"destructiveHint": false
|
|
1426
|
+
},
|
|
1134
1427
|
"description": "Retrieve detailed information about a specified virtual machine.\n\nUse this endpoint to view comprehensive VPS configuration and status.",
|
|
1135
1428
|
"method": "GET",
|
|
1136
1429
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}",
|
|
@@ -1155,6 +1448,12 @@ export default [
|
|
|
1155
1448
|
},
|
|
1156
1449
|
{
|
|
1157
1450
|
"name": "VPS_getVirtualMachinesV1",
|
|
1451
|
+
"title": "Get virtual machines",
|
|
1452
|
+
"annotations": {
|
|
1453
|
+
"title": "Get virtual machines",
|
|
1454
|
+
"readOnlyHint": true,
|
|
1455
|
+
"destructiveHint": false
|
|
1456
|
+
},
|
|
1158
1457
|
"description": "Retrieve all available virtual machines.\n\nUse this endpoint to view available VPS instances.",
|
|
1159
1458
|
"method": "GET",
|
|
1160
1459
|
"path": "/api/vps/v1/virtual-machines",
|
|
@@ -1172,6 +1471,12 @@ export default [
|
|
|
1172
1471
|
},
|
|
1173
1472
|
{
|
|
1174
1473
|
"name": "VPS_purchaseNewVirtualMachineV1",
|
|
1474
|
+
"title": "Purchase new virtual machine",
|
|
1475
|
+
"annotations": {
|
|
1476
|
+
"title": "Purchase new virtual machine",
|
|
1477
|
+
"readOnlyHint": false,
|
|
1478
|
+
"destructiveHint": false
|
|
1479
|
+
},
|
|
1175
1480
|
"description": "Purchase and setup a new virtual machine.\n\nIf virtual machine setup fails for any reason, login to\n[hPanel](https://hpanel.hostinger.com/) and complete the setup manually.\n\nIf no payment method is provided, your default payment method will be used automatically.\n\nUse this endpoint to create new VPS instances.",
|
|
1176
1481
|
"method": "POST",
|
|
1177
1482
|
"path": "/api/vps/v1/virtual-machines",
|
|
@@ -1213,6 +1518,12 @@ export default [
|
|
|
1213
1518
|
},
|
|
1214
1519
|
{
|
|
1215
1520
|
"name": "VPS_getScanMetricsV1",
|
|
1521
|
+
"title": "Get scan metrics",
|
|
1522
|
+
"annotations": {
|
|
1523
|
+
"title": "Get scan metrics",
|
|
1524
|
+
"readOnlyHint": true,
|
|
1525
|
+
"destructiveHint": false
|
|
1526
|
+
},
|
|
1216
1527
|
"description": "Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner\ninstalled on a specified virtual machine.\n\nThe scan metrics provide detailed information about malware scans performed\nby Monarx, including number of scans, detected threats, and other relevant\nstatistics. This information is useful for monitoring security status of the\nvirtual machine and assessing effectiveness of the malware scanner.\n\nUse this endpoint to monitor VPS security scan results and threat detection.",
|
|
1217
1528
|
"method": "GET",
|
|
1218
1529
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/monarx",
|
|
@@ -1237,6 +1548,12 @@ export default [
|
|
|
1237
1548
|
},
|
|
1238
1549
|
{
|
|
1239
1550
|
"name": "VPS_installMonarxV1",
|
|
1551
|
+
"title": "Install Monarx",
|
|
1552
|
+
"annotations": {
|
|
1553
|
+
"title": "Install Monarx",
|
|
1554
|
+
"readOnlyHint": false,
|
|
1555
|
+
"destructiveHint": false
|
|
1556
|
+
},
|
|
1240
1557
|
"description": "Install the Monarx malware scanner on a specified virtual machine.\n\n[Monarx](https://www.monarx.com/) is a security tool designed to detect and\nprevent malware infections on virtual machines. By installing Monarx, users\ncan enhance the security of their virtual machines, ensuring that they are\nprotected against malicious software.\n\nUse this endpoint to enable malware protection on VPS instances.",
|
|
1241
1558
|
"method": "POST",
|
|
1242
1559
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/monarx",
|
|
@@ -1261,6 +1578,13 @@ export default [
|
|
|
1261
1578
|
},
|
|
1262
1579
|
{
|
|
1263
1580
|
"name": "VPS_uninstallMonarxV1",
|
|
1581
|
+
"title": "Uninstall Monarx",
|
|
1582
|
+
"annotations": {
|
|
1583
|
+
"title": "Uninstall Monarx",
|
|
1584
|
+
"readOnlyHint": false,
|
|
1585
|
+
"destructiveHint": true,
|
|
1586
|
+
"idempotentHint": true
|
|
1587
|
+
},
|
|
1264
1588
|
"description": "Uninstall the Monarx malware scanner on a specified virtual machine.\n\nIf Monarx is not installed, the request will still be processed without any effect.\n\nUse this endpoint to remove malware scanner from VPS instances.",
|
|
1265
1589
|
"method": "DELETE",
|
|
1266
1590
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/monarx",
|
|
@@ -1285,6 +1609,12 @@ export default [
|
|
|
1285
1609
|
},
|
|
1286
1610
|
{
|
|
1287
1611
|
"name": "VPS_getMetricsV1",
|
|
1612
|
+
"title": "Get metrics",
|
|
1613
|
+
"annotations": {
|
|
1614
|
+
"title": "Get metrics",
|
|
1615
|
+
"readOnlyHint": true,
|
|
1616
|
+
"destructiveHint": false
|
|
1617
|
+
},
|
|
1288
1618
|
"description": "Retrieve historical metrics for a specified virtual machine.\n\nIt includes the following metrics: \n- CPU usage\n- Memory usage\n- Disk usage\n- Network usage\n- Uptime\n\nUse this endpoint to monitor VPS performance and resource utilization over time.",
|
|
1289
1619
|
"method": "GET",
|
|
1290
1620
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/metrics",
|
|
@@ -1319,6 +1649,13 @@ export default [
|
|
|
1319
1649
|
},
|
|
1320
1650
|
{
|
|
1321
1651
|
"name": "VPS_setNameserversV1",
|
|
1652
|
+
"title": "Set nameservers",
|
|
1653
|
+
"annotations": {
|
|
1654
|
+
"title": "Set nameservers",
|
|
1655
|
+
"readOnlyHint": false,
|
|
1656
|
+
"destructiveHint": true,
|
|
1657
|
+
"idempotentHint": true
|
|
1658
|
+
},
|
|
1322
1659
|
"description": "Set nameservers for a specified virtual machine.\n\nBe aware, that improper nameserver configuration can lead to the virtual\nmachine being unable to resolve domain names.\n\nUse this endpoint to configure custom DNS resolvers for VPS instances.",
|
|
1323
1660
|
"method": "PUT",
|
|
1324
1661
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers",
|
|
@@ -1356,6 +1693,12 @@ export default [
|
|
|
1356
1693
|
},
|
|
1357
1694
|
{
|
|
1358
1695
|
"name": "VPS_createPTRRecordV1",
|
|
1696
|
+
"title": "Create PTR record",
|
|
1697
|
+
"annotations": {
|
|
1698
|
+
"title": "Create PTR record",
|
|
1699
|
+
"readOnlyHint": false,
|
|
1700
|
+
"destructiveHint": false
|
|
1701
|
+
},
|
|
1359
1702
|
"description": "Create or update a PTR (Pointer) record for a specified virtual machine.\n\nUse this endpoint to configure reverse DNS lookup for VPS IP addresses.",
|
|
1360
1703
|
"method": "POST",
|
|
1361
1704
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}",
|
|
@@ -1390,6 +1733,13 @@ export default [
|
|
|
1390
1733
|
},
|
|
1391
1734
|
{
|
|
1392
1735
|
"name": "VPS_deletePTRRecordV1",
|
|
1736
|
+
"title": "Delete PTR record",
|
|
1737
|
+
"annotations": {
|
|
1738
|
+
"title": "Delete PTR record",
|
|
1739
|
+
"readOnlyHint": false,
|
|
1740
|
+
"destructiveHint": true,
|
|
1741
|
+
"idempotentHint": true
|
|
1742
|
+
},
|
|
1393
1743
|
"description": "Delete a PTR (Pointer) record for a specified virtual machine.\n\nOnce deleted, reverse DNS lookups to the virtual machine's IP address will\nno longer return the previously configured hostname.\n\nUse this endpoint to remove reverse DNS configuration from VPS instances.",
|
|
1394
1744
|
"method": "DELETE",
|
|
1395
1745
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}",
|
|
@@ -1419,6 +1769,13 @@ export default [
|
|
|
1419
1769
|
},
|
|
1420
1770
|
{
|
|
1421
1771
|
"name": "VPS_setPanelPasswordV1",
|
|
1772
|
+
"title": "Set panel password",
|
|
1773
|
+
"annotations": {
|
|
1774
|
+
"title": "Set panel password",
|
|
1775
|
+
"readOnlyHint": false,
|
|
1776
|
+
"destructiveHint": true,
|
|
1777
|
+
"idempotentHint": true
|
|
1778
|
+
},
|
|
1422
1779
|
"description": "Set panel password for a specified virtual machine.\n\nIf virtual machine does not use panel OS, the request will still be processed without any effect.\nRequirements for password are same as in the [recreate virtual machine\nendpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).\n\nUse this endpoint to configure control panel access credentials for VPS instances.",
|
|
1423
1780
|
"method": "PUT",
|
|
1424
1781
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password",
|
|
@@ -1448,6 +1805,12 @@ export default [
|
|
|
1448
1805
|
},
|
|
1449
1806
|
{
|
|
1450
1807
|
"name": "VPS_startRecoveryModeV1",
|
|
1808
|
+
"title": "Start recovery mode",
|
|
1809
|
+
"annotations": {
|
|
1810
|
+
"title": "Start recovery mode",
|
|
1811
|
+
"readOnlyHint": false,
|
|
1812
|
+
"destructiveHint": false
|
|
1813
|
+
},
|
|
1451
1814
|
"description": "Initiate recovery mode for a specified virtual machine.\n\nRecovery mode is a special state that allows users to perform system rescue operations, \nsuch as repairing file systems, recovering data, or troubleshooting issues that prevent the virtual machine \nfrom booting normally. \n\nVirtual machine will boot recovery disk image and original disk image will be mounted in `/mnt` directory.\n\nUse this endpoint to enable system rescue operations on VPS instances.",
|
|
1452
1815
|
"method": "POST",
|
|
1453
1816
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/recovery",
|
|
@@ -1477,6 +1840,13 @@ export default [
|
|
|
1477
1840
|
},
|
|
1478
1841
|
{
|
|
1479
1842
|
"name": "VPS_stopRecoveryModeV1",
|
|
1843
|
+
"title": "Stop recovery mode",
|
|
1844
|
+
"annotations": {
|
|
1845
|
+
"title": "Stop recovery mode",
|
|
1846
|
+
"readOnlyHint": false,
|
|
1847
|
+
"destructiveHint": true,
|
|
1848
|
+
"idempotentHint": true
|
|
1849
|
+
},
|
|
1480
1850
|
"description": "Stop recovery mode for a specified virtual machine.\n\nIf virtual machine is not in recovery mode, this operation will fail.\n\nUse this endpoint to exit system rescue mode and return VPS to normal operation.",
|
|
1481
1851
|
"method": "DELETE",
|
|
1482
1852
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/recovery",
|
|
@@ -1501,6 +1871,12 @@ export default [
|
|
|
1501
1871
|
},
|
|
1502
1872
|
{
|
|
1503
1873
|
"name": "VPS_recreateVirtualMachineV1",
|
|
1874
|
+
"title": "Recreate virtual machine",
|
|
1875
|
+
"annotations": {
|
|
1876
|
+
"title": "Recreate virtual machine",
|
|
1877
|
+
"readOnlyHint": false,
|
|
1878
|
+
"destructiveHint": true
|
|
1879
|
+
},
|
|
1504
1880
|
"description": "Recreate a virtual machine from scratch.\n\nThe recreation process involves reinstalling the operating system and\nresetting the virtual machine to its initial state.\nSnapshots, if there are any, will be deleted.\n\n## Password Requirements\nPassword will be checked against leaked password databases. \nRequirements for the password are:\n- At least 12 characters long\n- At least one uppercase letter\n- At least one lowercase letter\n- At least one number\n- Is not leaked publicly\n\n**This operation is irreversible and will result in the loss of all data stored on the virtual machine!**\n\nUse this endpoint to completely rebuild VPS instances with fresh OS installation.",
|
|
1505
1881
|
"method": "POST",
|
|
1506
1882
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/recreate",
|
|
@@ -1542,6 +1918,12 @@ export default [
|
|
|
1542
1918
|
},
|
|
1543
1919
|
{
|
|
1544
1920
|
"name": "VPS_restartVirtualMachineV1",
|
|
1921
|
+
"title": "Restart virtual machine",
|
|
1922
|
+
"annotations": {
|
|
1923
|
+
"title": "Restart virtual machine",
|
|
1924
|
+
"readOnlyHint": false,
|
|
1925
|
+
"destructiveHint": false
|
|
1926
|
+
},
|
|
1545
1927
|
"description": "Restart a specified virtual machine by fully stopping and starting it.\n\nIf the virtual machine was stopped, it will be started.\n\nUse this endpoint to reboot VPS instances.",
|
|
1546
1928
|
"method": "POST",
|
|
1547
1929
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/restart",
|
|
@@ -1566,6 +1948,13 @@ export default [
|
|
|
1566
1948
|
},
|
|
1567
1949
|
{
|
|
1568
1950
|
"name": "VPS_setRootPasswordV1",
|
|
1951
|
+
"title": "Set root password",
|
|
1952
|
+
"annotations": {
|
|
1953
|
+
"title": "Set root password",
|
|
1954
|
+
"readOnlyHint": false,
|
|
1955
|
+
"destructiveHint": true,
|
|
1956
|
+
"idempotentHint": true
|
|
1957
|
+
},
|
|
1569
1958
|
"description": "Set root password for a specified virtual machine.\n\nRequirements for password are same as in the [recreate virtual machine\nendpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).\n\nUse this endpoint to update administrator credentials for VPS instances.",
|
|
1570
1959
|
"method": "PUT",
|
|
1571
1960
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/root-password",
|
|
@@ -1595,6 +1984,12 @@ export default [
|
|
|
1595
1984
|
},
|
|
1596
1985
|
{
|
|
1597
1986
|
"name": "VPS_setupPurchasedVirtualMachineV1",
|
|
1987
|
+
"title": "Setup purchased virtual machine",
|
|
1988
|
+
"annotations": {
|
|
1989
|
+
"title": "Setup purchased virtual machine",
|
|
1990
|
+
"readOnlyHint": false,
|
|
1991
|
+
"destructiveHint": false
|
|
1992
|
+
},
|
|
1598
1993
|
"description": "Setup newly purchased virtual machine with `initial` state.\n\nUse this endpoint to configure and initialize purchased VPS instances.",
|
|
1599
1994
|
"method": "POST",
|
|
1600
1995
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/setup",
|
|
@@ -1671,6 +2066,12 @@ export default [
|
|
|
1671
2066
|
},
|
|
1672
2067
|
{
|
|
1673
2068
|
"name": "VPS_getSnapshotV1",
|
|
2069
|
+
"title": "Get snapshot",
|
|
2070
|
+
"annotations": {
|
|
2071
|
+
"title": "Get snapshot",
|
|
2072
|
+
"readOnlyHint": true,
|
|
2073
|
+
"destructiveHint": false
|
|
2074
|
+
},
|
|
1674
2075
|
"description": "Retrieve snapshot for a specified virtual machine.\n\nUse this endpoint to view current VPS snapshot information.",
|
|
1675
2076
|
"method": "GET",
|
|
1676
2077
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot",
|
|
@@ -1695,6 +2096,12 @@ export default [
|
|
|
1695
2096
|
},
|
|
1696
2097
|
{
|
|
1697
2098
|
"name": "VPS_createSnapshotV1",
|
|
2099
|
+
"title": "Create snapshot",
|
|
2100
|
+
"annotations": {
|
|
2101
|
+
"title": "Create snapshot",
|
|
2102
|
+
"readOnlyHint": false,
|
|
2103
|
+
"destructiveHint": false
|
|
2104
|
+
},
|
|
1698
2105
|
"description": "Create a snapshot of a specified virtual machine.\n\nA snapshot captures the state and data of the virtual machine at a specific point in time, \nallowing users to restore the virtual machine to that state if needed. \nThis operation is useful for backup purposes, system recovery, \nand testing changes without affecting the current state of the virtual machine.\n\n**Creating new snapshot will overwrite the existing snapshot!**\n\nUse this endpoint to capture VPS state for backup and recovery purposes.",
|
|
1699
2106
|
"method": "POST",
|
|
1700
2107
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot",
|
|
@@ -1719,6 +2126,13 @@ export default [
|
|
|
1719
2126
|
},
|
|
1720
2127
|
{
|
|
1721
2128
|
"name": "VPS_deleteSnapshotV1",
|
|
2129
|
+
"title": "Delete snapshot",
|
|
2130
|
+
"annotations": {
|
|
2131
|
+
"title": "Delete snapshot",
|
|
2132
|
+
"readOnlyHint": false,
|
|
2133
|
+
"destructiveHint": true,
|
|
2134
|
+
"idempotentHint": true
|
|
2135
|
+
},
|
|
1722
2136
|
"description": "Delete a snapshot of a specified virtual machine.\n\nUse this endpoint to remove VPS snapshots.",
|
|
1723
2137
|
"method": "DELETE",
|
|
1724
2138
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot",
|
|
@@ -1743,6 +2157,12 @@ export default [
|
|
|
1743
2157
|
},
|
|
1744
2158
|
{
|
|
1745
2159
|
"name": "VPS_restoreSnapshotV1",
|
|
2160
|
+
"title": "Restore snapshot",
|
|
2161
|
+
"annotations": {
|
|
2162
|
+
"title": "Restore snapshot",
|
|
2163
|
+
"readOnlyHint": false,
|
|
2164
|
+
"destructiveHint": true
|
|
2165
|
+
},
|
|
1746
2166
|
"description": "Restore a specified virtual machine to a previous state using a snapshot.\n\nRestoring from a snapshot allows users to revert the virtual machine to that state,\nwhich is useful for system recovery, undoing changes, or testing.\n\nUse this endpoint to revert VPS instances to previous saved states.",
|
|
1747
2167
|
"method": "POST",
|
|
1748
2168
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore",
|
|
@@ -1767,6 +2187,12 @@ export default [
|
|
|
1767
2187
|
},
|
|
1768
2188
|
{
|
|
1769
2189
|
"name": "VPS_startVirtualMachineV1",
|
|
2190
|
+
"title": "Start virtual machine",
|
|
2191
|
+
"annotations": {
|
|
2192
|
+
"title": "Start virtual machine",
|
|
2193
|
+
"readOnlyHint": false,
|
|
2194
|
+
"destructiveHint": false
|
|
2195
|
+
},
|
|
1770
2196
|
"description": "Start a specified virtual machine.\n\nIf the virtual machine is already running, the request will still be processed without any effect.\n\nUse this endpoint to power on stopped VPS instances.",
|
|
1771
2197
|
"method": "POST",
|
|
1772
2198
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/start",
|
|
@@ -1791,6 +2217,12 @@ export default [
|
|
|
1791
2217
|
},
|
|
1792
2218
|
{
|
|
1793
2219
|
"name": "VPS_stopVirtualMachineV1",
|
|
2220
|
+
"title": "Stop virtual machine",
|
|
2221
|
+
"annotations": {
|
|
2222
|
+
"title": "Stop virtual machine",
|
|
2223
|
+
"readOnlyHint": false,
|
|
2224
|
+
"destructiveHint": true
|
|
2225
|
+
},
|
|
1794
2226
|
"description": "Stop a specified virtual machine.\n\nIf the virtual machine is already stopped, the request will still be processed without any effect.\n\nThis is a compute-only power state change and does not affect billing. To stop future charges,\ndisable auto-renewal on the owning subscription.\n\nUse this endpoint to power off running VPS instances.",
|
|
1795
2227
|
"method": "POST",
|
|
1796
2228
|
"path": "/api/vps/v1/virtual-machines/{virtualMachineId}/stop",
|