hostinger-api-mcp 0.1.27 → 0.1.36
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 +124 -80
- package/package.json +1 -1
- package/server.js +83 -95
- package/server.ts +83 -95
- package/types.d.ts +138 -88
package/README.md
CHANGED
|
@@ -241,7 +241,8 @@ Retrieve logs for a specified JavaScript application deployment for debugging pu
|
|
|
241
241
|
|
|
242
242
|
Retrieve catalog items available for order.
|
|
243
243
|
|
|
244
|
-
Prices in catalog items is displayed as cents (without floating point),
|
|
244
|
+
Prices in catalog items is displayed as cents (without floating point),
|
|
245
|
+
e.g: float `17.99` is displayed as integer `1799`.
|
|
245
246
|
|
|
246
247
|
Use this endpoint to view available services and pricing before placing orders.
|
|
247
248
|
|
|
@@ -253,34 +254,6 @@ Use this endpoint to view available services and pricing before placing orders.
|
|
|
253
254
|
- `category`: Filter catalog items by category
|
|
254
255
|
- `name`: Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain
|
|
255
256
|
|
|
256
|
-
### billing_createServiceOrderV1
|
|
257
|
-
|
|
258
|
-
Create a new service order.
|
|
259
|
-
|
|
260
|
-
**DEPRECATED**
|
|
261
|
-
|
|
262
|
-
To purchase a domain, use [`POST /api/domains/v1/portfolio`](/#tag/domains-portfolio/POST/api/domains/v1/portfolio) instead.
|
|
263
|
-
|
|
264
|
-
To purchase a VPS, use [`POST /api/vps/v1/virtual-machines`](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines) instead.
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
To place order, you need to provide payment method ID and list of price items from the catalog endpoint together with quantity.
|
|
268
|
-
Coupons also can be provided during order creation.
|
|
269
|
-
|
|
270
|
-
Orders created using this endpoint will be set for automatic renewal.
|
|
271
|
-
|
|
272
|
-
Some `credit_card` payments might need additional verification, rendering purchase unprocessed.
|
|
273
|
-
We recommend use other payment methods than `credit_card` if you encounter this issue.
|
|
274
|
-
|
|
275
|
-
- **Method**: `POST`
|
|
276
|
-
- **Path**: `/api/billing/v1/orders`
|
|
277
|
-
|
|
278
|
-
**Parameters**:
|
|
279
|
-
|
|
280
|
-
- `payment_method_id`: Payment method ID (required)
|
|
281
|
-
- `items`: items parameter (required)
|
|
282
|
-
- `coupons`: Discount coupon codes
|
|
283
|
-
|
|
284
257
|
### billing_setDefaultPaymentMethodV1
|
|
285
258
|
|
|
286
259
|
Set the default payment method for your account.
|
|
@@ -311,7 +284,8 @@ Use this endpoint to remove unused payment methods from user accounts.
|
|
|
311
284
|
|
|
312
285
|
Retrieve available payment methods that can be used for placing new orders.
|
|
313
286
|
|
|
314
|
-
If you want to add new payment method,
|
|
287
|
+
If you want to add new payment method,
|
|
288
|
+
please use [hPanel](https://hpanel.hostinger.com/billing/payment-methods).
|
|
315
289
|
|
|
316
290
|
Use this endpoint to view available payment options before creating orders.
|
|
317
291
|
|
|
@@ -426,7 +400,9 @@ Use this endpoint to modify domain DNS configuration.
|
|
|
426
400
|
**Parameters**:
|
|
427
401
|
|
|
428
402
|
- `domain`: Domain name (required)
|
|
429
|
-
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
403
|
+
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
404
|
+
otherwise resource records' ttl's are updated and new records are appended.
|
|
405
|
+
If no matching RRs are found, they are created.
|
|
430
406
|
- `zone`: zone parameter (required)
|
|
431
407
|
|
|
432
408
|
### DNS_deleteDNSRecordsV1
|
|
@@ -479,7 +455,9 @@ Use this endpoint to verify DNS record validity before applying changes.
|
|
|
479
455
|
**Parameters**:
|
|
480
456
|
|
|
481
457
|
- `domain`: Domain name (required)
|
|
482
|
-
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
458
|
+
- `overwrite`: If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
459
|
+
otherwise resource records' ttl's are updated and new records are appended.
|
|
460
|
+
If no matching RRs are found, they are created.
|
|
483
461
|
- `zone`: zone parameter (required)
|
|
484
462
|
|
|
485
463
|
### v2_getDomainVerificationsDIRECT
|
|
@@ -557,7 +535,8 @@ Use this endpoint to set up domain redirects to other URLs.
|
|
|
557
535
|
|
|
558
536
|
Enable domain lock for the domain.
|
|
559
537
|
|
|
560
|
-
When domain lock is enabled,
|
|
538
|
+
When domain lock is enabled,
|
|
539
|
+
the domain cannot be transferred to another registrar without first disabling the lock.
|
|
561
540
|
|
|
562
541
|
Use this endpoint to secure domains against unauthorized transfers.
|
|
563
542
|
|
|
@@ -615,7 +594,7 @@ If registration fails, login to [hPanel](https://hpanel.hostinger.com/) and chec
|
|
|
615
594
|
|
|
616
595
|
If no payment method is provided, your default payment method will be used automatically.
|
|
617
596
|
|
|
618
|
-
If no WHOIS information is provided, default contact information for that TLD will be used.
|
|
597
|
+
If no WHOIS information is provided, default contact information for that TLD will be used.
|
|
619
598
|
Before making request, ensure WHOIS information for desired TLD exists in your account.
|
|
620
599
|
|
|
621
600
|
Some TLDs require `additional_details` to be provided and these will be validated before completing purchase.
|
|
@@ -754,8 +733,10 @@ Use this endpoint to view which domains use specific contact profiles.
|
|
|
754
733
|
|
|
755
734
|
### hosting_listAvailableDatacentersV1
|
|
756
735
|
|
|
757
|
-
Retrieve a list of datacenters available for setting up hosting plans
|
|
758
|
-
|
|
736
|
+
Retrieve a list of datacenters available for setting up hosting plans
|
|
737
|
+
based on available datacenter capacity and hosting plan of your order.
|
|
738
|
+
The first item in the list is the best match for your specific order
|
|
739
|
+
requirements.
|
|
759
740
|
|
|
760
741
|
- **Method**: `GET`
|
|
761
742
|
- **Path**: `/api/hosting/v1/datacenters`
|
|
@@ -767,7 +748,8 @@ The first item in the list is the best match for your specific order requirement
|
|
|
767
748
|
### hosting_generateAFreeSubdomainV1
|
|
768
749
|
|
|
769
750
|
Generate a unique free subdomain that can be used for hosting services without purchasing custom domains.
|
|
770
|
-
Free subdomains allow you to start using hosting services immediately
|
|
751
|
+
Free subdomains allow you to start using hosting services immediately
|
|
752
|
+
and you can always connect a custom domain to your site later.
|
|
771
753
|
|
|
772
754
|
- **Method**: `POST`
|
|
773
755
|
- **Path**: `/api/hosting/v1/domains/free-subdomains`
|
|
@@ -796,9 +778,11 @@ Skip this verification when using Hostinger's free subdomains (*.hostingersite.c
|
|
|
796
778
|
|
|
797
779
|
Retrieve a paginated list of orders accessible to the authenticated client.
|
|
798
780
|
|
|
799
|
-
This endpoint returns orders of your hosting accounts as well as orders
|
|
781
|
+
This endpoint returns orders of your hosting accounts as well as orders
|
|
782
|
+
of other client hosting accounts that have shared access with you.
|
|
800
783
|
|
|
801
|
-
Use the available query parameters to filter results by order statuses
|
|
784
|
+
Use the available query parameters to filter results by order statuses
|
|
785
|
+
or specific order IDs for more targeted results.
|
|
802
786
|
|
|
803
787
|
- **Method**: `GET`
|
|
804
788
|
- **Path**: `/api/hosting/v1/orders`
|
|
@@ -814,9 +798,12 @@ Use the available query parameters to filter results by order statuses or specif
|
|
|
814
798
|
|
|
815
799
|
Retrieve a paginated list of websites (main and addon types) accessible to the authenticated client.
|
|
816
800
|
|
|
817
|
-
This endpoint returns websites from your hosting accounts as well as
|
|
801
|
+
This endpoint returns websites from your hosting accounts as well as
|
|
802
|
+
websites from other client hosting accounts that have shared access
|
|
803
|
+
with you.
|
|
818
804
|
|
|
819
|
-
Use the available query parameters to filter results by username,
|
|
805
|
+
Use the available query parameters to filter results by username,
|
|
806
|
+
order ID, enabled status, or domain name for more targeted results.
|
|
820
807
|
|
|
821
808
|
- **Method**: `GET`
|
|
822
809
|
- **Path**: `/api/hosting/v1/websites`
|
|
@@ -834,11 +821,15 @@ Use the available query parameters to filter results by username, order ID, enab
|
|
|
834
821
|
|
|
835
822
|
Create a new website for the authenticated client.
|
|
836
823
|
|
|
837
|
-
Provide the domain name and associated order ID to create a new website.
|
|
824
|
+
Provide the domain name and associated order ID to create a new website.
|
|
825
|
+
The datacenter_code parameter is required when creating the first website
|
|
826
|
+
on a new hosting plan - this will set up and configure new hosting account
|
|
827
|
+
in the selected datacenter.
|
|
838
828
|
|
|
839
829
|
Subsequent websites will be hosted on the same datacenter automatically.
|
|
840
830
|
|
|
841
|
-
Website creation takes up to a few minutes to complete. Check the
|
|
831
|
+
Website creation takes up to a few minutes to complete. Check the
|
|
832
|
+
websites list endpoint to see when your new website becomes available.
|
|
842
833
|
|
|
843
834
|
- **Method**: `POST`
|
|
844
835
|
- **Path**: `/api/hosting/v1/websites`
|
|
@@ -895,7 +886,8 @@ Create a new contact in the email marketing system.
|
|
|
895
886
|
|
|
896
887
|
This endpoint allows you to create a new contact with basic information like name, email, and surname.
|
|
897
888
|
|
|
898
|
-
If double opt-in is enabled,
|
|
889
|
+
If double opt-in is enabled,
|
|
890
|
+
the contact will be created with a pending status and a confirmation email will be sent.
|
|
899
891
|
|
|
900
892
|
- **Method**: `POST`
|
|
901
893
|
- **Path**: `/api/reach/v1/contacts`
|
|
@@ -964,6 +956,26 @@ Segments are used to organize and group contacts based on specific criteria.
|
|
|
964
956
|
|
|
965
957
|
- `segmentUuid`: Segment uuid parameter (required)
|
|
966
958
|
|
|
959
|
+
### reach_createNewContactsV1
|
|
960
|
+
|
|
961
|
+
Create a new contact in the email marketing system.
|
|
962
|
+
|
|
963
|
+
This endpoint allows you to create a new contact with basic information like name, email, and surname.
|
|
964
|
+
|
|
965
|
+
If double opt-in is enabled, the contact will be created with a pending status
|
|
966
|
+
and a confirmation email will be sent.
|
|
967
|
+
|
|
968
|
+
- **Method**: `POST`
|
|
969
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/contacts`
|
|
970
|
+
|
|
971
|
+
**Parameters**:
|
|
972
|
+
|
|
973
|
+
- `profileUuid`: Profile uuid parameter (required)
|
|
974
|
+
- `email`: email parameter (required)
|
|
975
|
+
- `name`: name parameter
|
|
976
|
+
- `surname`: surname parameter
|
|
977
|
+
- `note`: note parameter
|
|
978
|
+
|
|
967
979
|
### reach_listProfilesV1
|
|
968
980
|
|
|
969
981
|
This endpoint returns all profiles available to the client, including their basic information.
|
|
@@ -988,7 +1000,8 @@ Use this endpoint to view location options before deploying VPS instances.
|
|
|
988
1000
|
|
|
989
1001
|
Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine.
|
|
990
1002
|
|
|
991
|
-
This endpoint returns detailed information about each container including
|
|
1003
|
+
This endpoint returns detailed information about each container including
|
|
1004
|
+
their current status, port mappings, and runtime configuration.
|
|
992
1005
|
|
|
993
1006
|
Use this to monitor the health and state of all services within your Docker Compose project.
|
|
994
1007
|
|
|
@@ -1002,7 +1015,8 @@ Use this to monitor the health and state of all services within your Docker Comp
|
|
|
1002
1015
|
|
|
1003
1016
|
### VPS_getProjectContentsV1
|
|
1004
1017
|
|
|
1005
|
-
Retrieves the complete project information including the docker-compose.yml
|
|
1018
|
+
Retrieves the complete project information including the docker-compose.yml
|
|
1019
|
+
file contents, project metadata, and current deployment status.
|
|
1006
1020
|
|
|
1007
1021
|
This endpoint provides the full configuration and state details of a specific Docker Compose project.
|
|
1008
1022
|
|
|
@@ -1037,9 +1051,11 @@ Use this when you want to permanently remove a project and free up system resour
|
|
|
1037
1051
|
|
|
1038
1052
|
Retrieves a list of all Docker Compose projects currently deployed on the virtual machine.
|
|
1039
1053
|
|
|
1040
|
-
This endpoint returns basic information about each project including name,
|
|
1041
|
-
|
|
1042
|
-
|
|
1054
|
+
This endpoint returns basic information about each project including name,
|
|
1055
|
+
status, file path and list of containers with details about their names,
|
|
1056
|
+
image, status, health and ports. Container stats are omitted in this
|
|
1057
|
+
endpoint. If you need to get detailed information about container with
|
|
1058
|
+
stats included, use the `Get project containers` endpoint.
|
|
1043
1059
|
|
|
1044
1060
|
Use this to get an overview of all Docker projects on your VPS instance.
|
|
1045
1061
|
|
|
@@ -1054,8 +1070,10 @@ Use this to get an overview of all Docker projects on your VPS instance.
|
|
|
1054
1070
|
|
|
1055
1071
|
Deploy new project from docker-compose.yaml contents or download contents from URL.
|
|
1056
1072
|
|
|
1057
|
-
URL can be Github repository url in format https://github.com/[user]/[repo]
|
|
1058
|
-
|
|
1073
|
+
URL can be Github repository url in format https://github.com/[user]/[repo]
|
|
1074
|
+
and it will be automatically resolved to docker-compose.yaml file in
|
|
1075
|
+
master branch. Any other URL provided must return docker-compose.yaml
|
|
1076
|
+
file contents.
|
|
1059
1077
|
|
|
1060
1078
|
If project with the same name already exists, existing project will be replaced.
|
|
1061
1079
|
|
|
@@ -1076,7 +1094,8 @@ Retrieves aggregated log entries from all services within a Docker Compose proje
|
|
|
1076
1094
|
This endpoint returns recent log output from each container, organized by service name with timestamps.
|
|
1077
1095
|
The response contains the last 300 log entries across all services.
|
|
1078
1096
|
|
|
1079
|
-
Use this for debugging, monitoring application behavior, and
|
|
1097
|
+
Use this for debugging, monitoring application behavior, and
|
|
1098
|
+
troubleshooting issues across your entire project stack.
|
|
1080
1099
|
|
|
1081
1100
|
- **Method**: `GET`
|
|
1082
1101
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs`
|
|
@@ -1088,7 +1107,8 @@ Use this for debugging, monitoring application behavior, and troubleshooting iss
|
|
|
1088
1107
|
|
|
1089
1108
|
### VPS_restartProjectV1
|
|
1090
1109
|
|
|
1091
|
-
Restarts all services in a Docker Compose project by stopping and starting
|
|
1110
|
+
Restarts all services in a Docker Compose project by stopping and starting
|
|
1111
|
+
containers in the correct dependency order.
|
|
1092
1112
|
|
|
1093
1113
|
This operation preserves data volumes and network configurations while refreshing the running containers.
|
|
1094
1114
|
|
|
@@ -1120,7 +1140,8 @@ Use this to resume a project that was previously stopped or to start services af
|
|
|
1120
1140
|
|
|
1121
1141
|
### VPS_stopProjectV1
|
|
1122
1142
|
|
|
1123
|
-
Stops all running services in a Docker Compose project while preserving
|
|
1143
|
+
Stops all running services in a Docker Compose project while preserving
|
|
1144
|
+
container configurations and data volumes.
|
|
1124
1145
|
|
|
1125
1146
|
This operation gracefully shuts down containers in reverse dependency order.
|
|
1126
1147
|
|
|
@@ -1136,11 +1157,13 @@ Use this to temporarily halt a project without removing data or configurations.
|
|
|
1136
1157
|
|
|
1137
1158
|
### VPS_updateProjectV1
|
|
1138
1159
|
|
|
1139
|
-
Updates a Docker Compose project by pulling the latest image versions and
|
|
1160
|
+
Updates a Docker Compose project by pulling the latest image versions and
|
|
1161
|
+
recreating containers with new configurations.
|
|
1140
1162
|
|
|
1141
1163
|
This operation preserves data volumes while applying changes from the compose file.
|
|
1142
1164
|
|
|
1143
|
-
Use this to deploy application updates, apply configuration changes, or
|
|
1165
|
+
Use this to deploy application updates, apply configuration changes, or
|
|
1166
|
+
refresh container images to their latest versions.
|
|
1144
1167
|
|
|
1145
1168
|
- **Method**: `POST`
|
|
1146
1169
|
- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update`
|
|
@@ -1238,7 +1261,8 @@ Use this endpoint to set up new firewall configurations for VPS security.
|
|
|
1238
1261
|
|
|
1239
1262
|
Update a specific firewall rule from a specified firewall.
|
|
1240
1263
|
|
|
1241
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1264
|
+
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1265
|
+
and will have to be synced again manually.
|
|
1242
1266
|
|
|
1243
1267
|
Use this endpoint to modify existing firewall rules.
|
|
1244
1268
|
|
|
@@ -1258,8 +1282,9 @@ Use this endpoint to modify existing firewall rules.
|
|
|
1258
1282
|
|
|
1259
1283
|
Delete a specific firewall rule from a specified firewall.
|
|
1260
1284
|
|
|
1261
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1262
|
-
|
|
1285
|
+
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1286
|
+
and will have to be synced again manually.
|
|
1287
|
+
|
|
1263
1288
|
Use this endpoint to remove specific firewall rules.
|
|
1264
1289
|
|
|
1265
1290
|
- **Method**: `DELETE`
|
|
@@ -1274,9 +1299,11 @@ Use this endpoint to remove specific firewall rules.
|
|
|
1274
1299
|
|
|
1275
1300
|
Create new firewall rule for a specified firewall.
|
|
1276
1301
|
|
|
1277
|
-
By default, the firewall drops all incoming traffic,
|
|
1302
|
+
By default, the firewall drops all incoming traffic,
|
|
1303
|
+
which means you must add accept rules for all ports you want to use.
|
|
1278
1304
|
|
|
1279
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1305
|
+
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1306
|
+
and will have to be synced again manually.
|
|
1280
1307
|
|
|
1281
1308
|
Use this endpoint to add new security rules to firewalls.
|
|
1282
1309
|
|
|
@@ -1365,7 +1392,8 @@ Use this endpoint to view available automation scripts for VPS deployment.
|
|
|
1365
1392
|
|
|
1366
1393
|
Add a new post-install script to your account, which can then be used after virtual machine installation.
|
|
1367
1394
|
|
|
1368
|
-
The script contents will be saved to the file `/post_install` with executable attribute set
|
|
1395
|
+
The script contents will be saved to the file `/post_install` with executable attribute set
|
|
1396
|
+
and will be executed once virtual machine is installed.
|
|
1369
1397
|
The output of the script will be redirected to `/post_install.log`. Maximum script size is 48KB.
|
|
1370
1398
|
|
|
1371
1399
|
Use this endpoint to create automation scripts for VPS setup tasks.
|
|
@@ -1478,9 +1506,10 @@ Use this endpoint to monitor specific VPS operation status and details.
|
|
|
1478
1506
|
|
|
1479
1507
|
Retrieve actions performed on a specified virtual machine.
|
|
1480
1508
|
|
|
1481
|
-
Actions are operations or events that have been executed on the virtual
|
|
1482
|
-
|
|
1483
|
-
|
|
1509
|
+
Actions are operations or events that have been executed on the virtual
|
|
1510
|
+
machine, such as starting, stopping, or modifying the machine. This endpoint
|
|
1511
|
+
allows you to view the history of these actions, providing details about
|
|
1512
|
+
each action, such as the action name, timestamp, and status.
|
|
1484
1513
|
|
|
1485
1514
|
Use this endpoint to view VPS operation history and troubleshoot issues.
|
|
1486
1515
|
|
|
@@ -1597,7 +1626,8 @@ Use this endpoint to view available VPS instances.
|
|
|
1597
1626
|
|
|
1598
1627
|
Purchase and setup a new virtual machine.
|
|
1599
1628
|
|
|
1600
|
-
If virtual machine setup fails for any reason, login to
|
|
1629
|
+
If virtual machine setup fails for any reason, login to
|
|
1630
|
+
[hPanel](https://hpanel.hostinger.com/) and complete the setup manually.
|
|
1601
1631
|
|
|
1602
1632
|
If no payment method is provided, your default payment method will be used automatically.
|
|
1603
1633
|
|
|
@@ -1615,10 +1645,12 @@ Use this endpoint to create new VPS instances.
|
|
|
1615
1645
|
|
|
1616
1646
|
### VPS_getScanMetricsV1
|
|
1617
1647
|
|
|
1618
|
-
Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner
|
|
1648
|
+
Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner
|
|
1649
|
+
installed on a specified virtual machine.
|
|
1619
1650
|
|
|
1620
|
-
The scan metrics provide detailed information about malware scans performed
|
|
1621
|
-
|
|
1651
|
+
The scan metrics provide detailed information about malware scans performed
|
|
1652
|
+
by Monarx, including number of scans, detected threats, and other relevant
|
|
1653
|
+
statistics. This information is useful for monitoring security status of the
|
|
1622
1654
|
virtual machine and assessing effectiveness of the malware scanner.
|
|
1623
1655
|
|
|
1624
1656
|
Use this endpoint to monitor VPS security scan results and threat detection.
|
|
@@ -1634,8 +1666,10 @@ Use this endpoint to monitor VPS security scan results and threat detection.
|
|
|
1634
1666
|
|
|
1635
1667
|
Install the Monarx malware scanner on a specified virtual machine.
|
|
1636
1668
|
|
|
1637
|
-
[Monarx](https://www.monarx.com/) is a security tool designed to detect and
|
|
1638
|
-
|
|
1669
|
+
[Monarx](https://www.monarx.com/) is a security tool designed to detect and
|
|
1670
|
+
prevent malware infections on virtual machines. By installing Monarx, users
|
|
1671
|
+
can enhance the security of their virtual machines, ensuring that they are
|
|
1672
|
+
protected against malicious software.
|
|
1639
1673
|
|
|
1640
1674
|
Use this endpoint to enable malware protection on VPS instances.
|
|
1641
1675
|
|
|
@@ -1687,7 +1721,8 @@ Use this endpoint to monitor VPS performance and resource utilization over time.
|
|
|
1687
1721
|
|
|
1688
1722
|
Set nameservers for a specified virtual machine.
|
|
1689
1723
|
|
|
1690
|
-
Be aware, that improper nameserver configuration can lead to the virtual
|
|
1724
|
+
Be aware, that improper nameserver configuration can lead to the virtual
|
|
1725
|
+
machine being unable to resolve domain names.
|
|
1691
1726
|
|
|
1692
1727
|
Use this endpoint to configure custom DNS resolvers for VPS instances.
|
|
1693
1728
|
|
|
@@ -1720,7 +1755,8 @@ Use this endpoint to configure reverse DNS lookup for VPS IP addresses.
|
|
|
1720
1755
|
|
|
1721
1756
|
Delete a PTR (Pointer) record for a specified virtual machine.
|
|
1722
1757
|
|
|
1723
|
-
Once deleted, reverse DNS lookups to the virtual machine's IP address will
|
|
1758
|
+
Once deleted, reverse DNS lookups to the virtual machine's IP address will
|
|
1759
|
+
no longer return the previously configured hostname.
|
|
1724
1760
|
|
|
1725
1761
|
Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
1726
1762
|
|
|
@@ -1737,7 +1773,8 @@ Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
|
1737
1773
|
Set panel password for a specified virtual machine.
|
|
1738
1774
|
|
|
1739
1775
|
If virtual machine does not use panel OS, the request will still be processed without any effect.
|
|
1740
|
-
Requirements for password are same as in the [recreate virtual machine
|
|
1776
|
+
Requirements for password are same as in the [recreate virtual machine
|
|
1777
|
+
endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).
|
|
1741
1778
|
|
|
1742
1779
|
Use this endpoint to configure control panel access credentials for VPS instances.
|
|
1743
1780
|
|
|
@@ -1788,7 +1825,8 @@ Use this endpoint to exit system rescue mode and return VPS to normal operation.
|
|
|
1788
1825
|
|
|
1789
1826
|
Recreate a virtual machine from scratch.
|
|
1790
1827
|
|
|
1791
|
-
The recreation process involves reinstalling the operating system and
|
|
1828
|
+
The recreation process involves reinstalling the operating system and
|
|
1829
|
+
resetting the virtual machine to its initial state.
|
|
1792
1830
|
Snapshots, if there are any, will be deleted.
|
|
1793
1831
|
|
|
1794
1832
|
## Password Requirements
|
|
@@ -1811,8 +1849,11 @@ Use this endpoint to completely rebuild VPS instances with fresh OS installation
|
|
|
1811
1849
|
|
|
1812
1850
|
- `virtualMachineId`: Virtual Machine ID (required)
|
|
1813
1851
|
- `template_id`: Template ID (required)
|
|
1814
|
-
- `password`: Root password for the virtual machine. If not provided, random password will be generated.
|
|
1815
|
-
|
|
1852
|
+
- `password`: Root password for the virtual machine. If not provided, random password will be generated.
|
|
1853
|
+
Password will not be shown in the response.
|
|
1854
|
+
- `panel_password`: Panel password for the panel-based OS template. If not provided, random password will be generated.
|
|
1855
|
+
If OS does not support panel_password this field will be ignored.
|
|
1856
|
+
Password will not be shown in the response.
|
|
1816
1857
|
- `post_install_script_id`: Post-install script to execute after virtual machine was recreated
|
|
1817
1858
|
|
|
1818
1859
|
### VPS_restartVirtualMachineV1
|
|
@@ -1834,7 +1875,8 @@ Use this endpoint to reboot VPS instances.
|
|
|
1834
1875
|
|
|
1835
1876
|
Set root password for a specified virtual machine.
|
|
1836
1877
|
|
|
1837
|
-
Requirements for password are same as in the [recreate virtual machine
|
|
1878
|
+
Requirements for password are same as in the [recreate virtual machine
|
|
1879
|
+
endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).
|
|
1838
1880
|
|
|
1839
1881
|
Use this endpoint to update administrator credentials for VPS instances.
|
|
1840
1882
|
|
|
@@ -1861,7 +1903,8 @@ Use this endpoint to configure and initialize purchased VPS instances.
|
|
|
1861
1903
|
- `template_id`: Template ID (required)
|
|
1862
1904
|
- `data_center_id`: Data center ID (required)
|
|
1863
1905
|
- `post_install_script_id`: Post-install script ID
|
|
1864
|
-
- `password`: Password for the virtual machine. If not provided, random password will be generated.
|
|
1906
|
+
- `password`: Password for the virtual machine. If not provided, random password will be generated.
|
|
1907
|
+
Password will not be shown in the response.
|
|
1865
1908
|
- `hostname`: Override default hostname of the virtual machine
|
|
1866
1909
|
- `install_monarx`: Install Monarx malware scanner (if supported)
|
|
1867
1910
|
- `enable_backups`: Enable weekly backup schedule
|
|
@@ -1919,7 +1962,8 @@ Use this endpoint to remove VPS snapshots.
|
|
|
1919
1962
|
|
|
1920
1963
|
Restore a specified virtual machine to a previous state using a snapshot.
|
|
1921
1964
|
|
|
1922
|
-
Restoring from a snapshot allows users to revert the virtual machine to that state,
|
|
1965
|
+
Restoring from a snapshot allows users to revert the virtual machine to that state,
|
|
1966
|
+
which is useful for system recovery, undoing changes, or testing.
|
|
1923
1967
|
|
|
1924
1968
|
Use this endpoint to revert VPS instances to previous saved states.
|
|
1925
1969
|
|