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/types.d.ts
CHANGED
|
@@ -162,7 +162,8 @@ export interface APITools {
|
|
|
162
162
|
/**
|
|
163
163
|
* Retrieve catalog items available for order.
|
|
164
164
|
|
|
165
|
-
Prices in catalog items is displayed as cents (without floating point),
|
|
165
|
+
Prices in catalog items is displayed as cents (without floating point),
|
|
166
|
+
e.g: float `17.99` is displayed as integer `1799`.
|
|
166
167
|
|
|
167
168
|
Use this endpoint to view available services and pricing before placing orders.
|
|
168
169
|
*/
|
|
@@ -180,42 +181,6 @@ Use this endpoint to view available services and pricing before placing orders.
|
|
|
180
181
|
response: any; // Response structure will depend on the API
|
|
181
182
|
};
|
|
182
183
|
|
|
183
|
-
/**
|
|
184
|
-
* Create a new service order.
|
|
185
|
-
|
|
186
|
-
**DEPRECATED**
|
|
187
|
-
|
|
188
|
-
To purchase a domain, use [`POST /api/domains/v1/portfolio`](/#tag/domains-portfolio/POST/api/domains/v1/portfolio) instead.
|
|
189
|
-
|
|
190
|
-
To purchase a VPS, use [`POST /api/vps/v1/virtual-machines`](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines) instead.
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
To place order, you need to provide payment method ID and list of price items from the catalog endpoint together with quantity.
|
|
194
|
-
Coupons also can be provided during order creation.
|
|
195
|
-
|
|
196
|
-
Orders created using this endpoint will be set for automatic renewal.
|
|
197
|
-
|
|
198
|
-
Some `credit_card` payments might need additional verification, rendering purchase unprocessed.
|
|
199
|
-
We recommend use other payment methods than `credit_card` if you encounter this issue.
|
|
200
|
-
*/
|
|
201
|
-
"billing_createServiceOrderV1": {
|
|
202
|
-
params: {
|
|
203
|
-
/**
|
|
204
|
-
* Payment method ID
|
|
205
|
-
*/
|
|
206
|
-
payment_method_id: number;
|
|
207
|
-
/**
|
|
208
|
-
* items parameter
|
|
209
|
-
*/
|
|
210
|
-
items: array;
|
|
211
|
-
/**
|
|
212
|
-
* Discount coupon codes
|
|
213
|
-
*/
|
|
214
|
-
coupons?: array;
|
|
215
|
-
};
|
|
216
|
-
response: any; // Response structure will depend on the API
|
|
217
|
-
};
|
|
218
|
-
|
|
219
184
|
/**
|
|
220
185
|
* Set the default payment method for your account.
|
|
221
186
|
|
|
@@ -249,7 +214,8 @@ Use this endpoint to remove unused payment methods from user accounts.
|
|
|
249
214
|
/**
|
|
250
215
|
* Retrieve available payment methods that can be used for placing new orders.
|
|
251
216
|
|
|
252
|
-
If you want to add new payment method,
|
|
217
|
+
If you want to add new payment method,
|
|
218
|
+
please use [hPanel](https://hpanel.hostinger.com/billing/payment-methods).
|
|
253
219
|
|
|
254
220
|
Use this endpoint to view available payment options before creating orders.
|
|
255
221
|
*/
|
|
@@ -385,7 +351,9 @@ Use this endpoint to modify domain DNS configuration.
|
|
|
385
351
|
*/
|
|
386
352
|
domain: string;
|
|
387
353
|
/**
|
|
388
|
-
* If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
354
|
+
* If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
355
|
+
otherwise resource records' ttl's are updated and new records are appended.
|
|
356
|
+
If no matching RRs are found, they are created.
|
|
389
357
|
*/
|
|
390
358
|
overwrite?: boolean;
|
|
391
359
|
/**
|
|
@@ -459,7 +427,9 @@ Use this endpoint to verify DNS record validity before applying changes.
|
|
|
459
427
|
*/
|
|
460
428
|
domain: string;
|
|
461
429
|
/**
|
|
462
|
-
* If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
430
|
+
* If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created,
|
|
431
|
+
otherwise resource records' ttl's are updated and new records are appended.
|
|
432
|
+
If no matching RRs are found, they are created.
|
|
463
433
|
*/
|
|
464
434
|
overwrite?: boolean;
|
|
465
435
|
/**
|
|
@@ -565,7 +535,8 @@ Use this endpoint to set up domain redirects to other URLs.
|
|
|
565
535
|
/**
|
|
566
536
|
* Enable domain lock for the domain.
|
|
567
537
|
|
|
568
|
-
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.
|
|
569
540
|
|
|
570
541
|
Use this endpoint to secure domains against unauthorized transfers.
|
|
571
542
|
*/
|
|
@@ -630,7 +601,7 @@ If registration fails, login to [hPanel](https://hpanel.hostinger.com/) and chec
|
|
|
630
601
|
|
|
631
602
|
If no payment method is provided, your default payment method will be used automatically.
|
|
632
603
|
|
|
633
|
-
If no WHOIS information is provided, default contact information for that TLD will be used.
|
|
604
|
+
If no WHOIS information is provided, default contact information for that TLD will be used.
|
|
634
605
|
Before making request, ensure WHOIS information for desired TLD exists in your account.
|
|
635
606
|
|
|
636
607
|
Some TLDs require `additional_details` to be provided and these will be validated before completing purchase.
|
|
@@ -826,8 +797,10 @@ Use this endpoint to view which domains use specific contact profiles.
|
|
|
826
797
|
};
|
|
827
798
|
|
|
828
799
|
/**
|
|
829
|
-
* Retrieve a list of datacenters available for setting up hosting plans
|
|
830
|
-
|
|
800
|
+
* Retrieve a list of datacenters available for setting up hosting plans
|
|
801
|
+
based on available datacenter capacity and hosting plan of your order.
|
|
802
|
+
The first item in the list is the best match for your specific order
|
|
803
|
+
requirements.
|
|
831
804
|
*/
|
|
832
805
|
"hosting_listAvailableDatacentersV1": {
|
|
833
806
|
params: {
|
|
@@ -841,7 +814,8 @@ The first item in the list is the best match for your specific order requirement
|
|
|
841
814
|
|
|
842
815
|
/**
|
|
843
816
|
* Generate a unique free subdomain that can be used for hosting services without purchasing custom domains.
|
|
844
|
-
Free subdomains allow you to start using hosting services immediately
|
|
817
|
+
Free subdomains allow you to start using hosting services immediately
|
|
818
|
+
and you can always connect a custom domain to your site later.
|
|
845
819
|
*/
|
|
846
820
|
"hosting_generateAFreeSubdomainV1": {
|
|
847
821
|
params: {
|
|
@@ -873,9 +847,11 @@ Skip this verification when using Hostinger's free subdomains (*.hostingersite.c
|
|
|
873
847
|
/**
|
|
874
848
|
* Retrieve a paginated list of orders accessible to the authenticated client.
|
|
875
849
|
|
|
876
|
-
This endpoint returns orders of your hosting accounts as well as orders
|
|
850
|
+
This endpoint returns orders of your hosting accounts as well as orders
|
|
851
|
+
of other client hosting accounts that have shared access with you.
|
|
877
852
|
|
|
878
|
-
Use the available query parameters to filter results by order statuses
|
|
853
|
+
Use the available query parameters to filter results by order statuses
|
|
854
|
+
or specific order IDs for more targeted results.
|
|
879
855
|
*/
|
|
880
856
|
"hosting_listOrdersV1": {
|
|
881
857
|
params: {
|
|
@@ -902,9 +878,12 @@ Use the available query parameters to filter results by order statuses or specif
|
|
|
902
878
|
/**
|
|
903
879
|
* Retrieve a paginated list of websites (main and addon types) accessible to the authenticated client.
|
|
904
880
|
|
|
905
|
-
This endpoint returns websites from your hosting accounts as well as
|
|
881
|
+
This endpoint returns websites from your hosting accounts as well as
|
|
882
|
+
websites from other client hosting accounts that have shared access
|
|
883
|
+
with you.
|
|
906
884
|
|
|
907
|
-
Use the available query parameters to filter results by username,
|
|
885
|
+
Use the available query parameters to filter results by username,
|
|
886
|
+
order ID, enabled status, or domain name for more targeted results.
|
|
908
887
|
*/
|
|
909
888
|
"hosting_listWebsitesV1": {
|
|
910
889
|
params: {
|
|
@@ -939,11 +918,15 @@ Use the available query parameters to filter results by username, order ID, enab
|
|
|
939
918
|
/**
|
|
940
919
|
* Create a new website for the authenticated client.
|
|
941
920
|
|
|
942
|
-
Provide the domain name and associated order ID to create a new website.
|
|
921
|
+
Provide the domain name and associated order ID to create a new website.
|
|
922
|
+
The datacenter_code parameter is required when creating the first website
|
|
923
|
+
on a new hosting plan - this will set up and configure new hosting account
|
|
924
|
+
in the selected datacenter.
|
|
943
925
|
|
|
944
926
|
Subsequent websites will be hosted on the same datacenter automatically.
|
|
945
927
|
|
|
946
|
-
Website creation takes up to a few minutes to complete. Check the
|
|
928
|
+
Website creation takes up to a few minutes to complete. Check the
|
|
929
|
+
websites list endpoint to see when your new website becomes available.
|
|
947
930
|
*/
|
|
948
931
|
"hosting_createWebsiteV1": {
|
|
949
932
|
params: {
|
|
@@ -1019,7 +1002,8 @@ You can filter contacts by group UUID and subscription status.
|
|
|
1019
1002
|
|
|
1020
1003
|
This endpoint allows you to create a new contact with basic information like name, email, and surname.
|
|
1021
1004
|
|
|
1022
|
-
If double opt-in is enabled,
|
|
1005
|
+
If double opt-in is enabled,
|
|
1006
|
+
the contact will be created with a pending status and a confirmation email will be sent.
|
|
1023
1007
|
*/
|
|
1024
1008
|
"reach_createANewContactV1": {
|
|
1025
1009
|
params: {
|
|
@@ -1119,6 +1103,40 @@ Segments are used to organize and group contacts based on specific criteria.
|
|
|
1119
1103
|
response: any; // Response structure will depend on the API
|
|
1120
1104
|
};
|
|
1121
1105
|
|
|
1106
|
+
/**
|
|
1107
|
+
* Create a new contact in the email marketing system.
|
|
1108
|
+
|
|
1109
|
+
This endpoint allows you to create a new contact with basic information like name, email, and surname.
|
|
1110
|
+
|
|
1111
|
+
If double opt-in is enabled, the contact will be created with a pending status
|
|
1112
|
+
and a confirmation email will be sent.
|
|
1113
|
+
*/
|
|
1114
|
+
"reach_createNewContactsV1": {
|
|
1115
|
+
params: {
|
|
1116
|
+
/**
|
|
1117
|
+
* Profile uuid parameter
|
|
1118
|
+
*/
|
|
1119
|
+
profileUuid: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* email parameter
|
|
1122
|
+
*/
|
|
1123
|
+
email: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* name parameter
|
|
1126
|
+
*/
|
|
1127
|
+
name?: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* surname parameter
|
|
1130
|
+
*/
|
|
1131
|
+
surname?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* note parameter
|
|
1134
|
+
*/
|
|
1135
|
+
note?: string;
|
|
1136
|
+
};
|
|
1137
|
+
response: any; // Response structure will depend on the API
|
|
1138
|
+
};
|
|
1139
|
+
|
|
1122
1140
|
/**
|
|
1123
1141
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
1124
1142
|
*/
|
|
@@ -1144,7 +1162,8 @@ Use this endpoint to view location options before deploying VPS instances.
|
|
|
1144
1162
|
/**
|
|
1145
1163
|
* Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine.
|
|
1146
1164
|
|
|
1147
|
-
This endpoint returns detailed information about each container including
|
|
1165
|
+
This endpoint returns detailed information about each container including
|
|
1166
|
+
their current status, port mappings, and runtime configuration.
|
|
1148
1167
|
|
|
1149
1168
|
Use this to monitor the health and state of all services within your Docker Compose project.
|
|
1150
1169
|
*/
|
|
@@ -1163,7 +1182,8 @@ Use this to monitor the health and state of all services within your Docker Comp
|
|
|
1163
1182
|
};
|
|
1164
1183
|
|
|
1165
1184
|
/**
|
|
1166
|
-
* Retrieves the complete project information including the docker-compose.yml
|
|
1185
|
+
* Retrieves the complete project information including the docker-compose.yml
|
|
1186
|
+
file contents, project metadata, and current deployment status.
|
|
1167
1187
|
|
|
1168
1188
|
This endpoint provides the full configuration and state details of a specific Docker Compose project.
|
|
1169
1189
|
|
|
@@ -1208,9 +1228,11 @@ Use this when you want to permanently remove a project and free up system resour
|
|
|
1208
1228
|
/**
|
|
1209
1229
|
* Retrieves a list of all Docker Compose projects currently deployed on the virtual machine.
|
|
1210
1230
|
|
|
1211
|
-
This endpoint returns basic information about each project including name,
|
|
1212
|
-
|
|
1213
|
-
|
|
1231
|
+
This endpoint returns basic information about each project including name,
|
|
1232
|
+
status, file path and list of containers with details about their names,
|
|
1233
|
+
image, status, health and ports. Container stats are omitted in this
|
|
1234
|
+
endpoint. If you need to get detailed information about container with
|
|
1235
|
+
stats included, use the `Get project containers` endpoint.
|
|
1214
1236
|
|
|
1215
1237
|
Use this to get an overview of all Docker projects on your VPS instance.
|
|
1216
1238
|
*/
|
|
@@ -1227,8 +1249,10 @@ Use this to get an overview of all Docker projects on your VPS instance.
|
|
|
1227
1249
|
/**
|
|
1228
1250
|
* Deploy new project from docker-compose.yaml contents or download contents from URL.
|
|
1229
1251
|
|
|
1230
|
-
URL can be Github repository url in format https://github.com/[user]/[repo]
|
|
1231
|
-
|
|
1252
|
+
URL can be Github repository url in format https://github.com/[user]/[repo]
|
|
1253
|
+
and it will be automatically resolved to docker-compose.yaml file in
|
|
1254
|
+
master branch. Any other URL provided must return docker-compose.yaml
|
|
1255
|
+
file contents.
|
|
1232
1256
|
|
|
1233
1257
|
If project with the same name already exists, existing project will be replaced.
|
|
1234
1258
|
*/
|
|
@@ -1260,7 +1284,8 @@ If project with the same name already exists, existing project will be replaced.
|
|
|
1260
1284
|
This endpoint returns recent log output from each container, organized by service name with timestamps.
|
|
1261
1285
|
The response contains the last 300 log entries across all services.
|
|
1262
1286
|
|
|
1263
|
-
Use this for debugging, monitoring application behavior, and
|
|
1287
|
+
Use this for debugging, monitoring application behavior, and
|
|
1288
|
+
troubleshooting issues across your entire project stack.
|
|
1264
1289
|
*/
|
|
1265
1290
|
"VPS_getProjectLogsV1": {
|
|
1266
1291
|
params: {
|
|
@@ -1277,7 +1302,8 @@ Use this for debugging, monitoring application behavior, and troubleshooting iss
|
|
|
1277
1302
|
};
|
|
1278
1303
|
|
|
1279
1304
|
/**
|
|
1280
|
-
* Restarts all services in a Docker Compose project by stopping and starting
|
|
1305
|
+
* Restarts all services in a Docker Compose project by stopping and starting
|
|
1306
|
+
containers in the correct dependency order.
|
|
1281
1307
|
|
|
1282
1308
|
This operation preserves data volumes and network configurations while refreshing the running containers.
|
|
1283
1309
|
|
|
@@ -1319,7 +1345,8 @@ Use this to resume a project that was previously stopped or to start services af
|
|
|
1319
1345
|
};
|
|
1320
1346
|
|
|
1321
1347
|
/**
|
|
1322
|
-
* Stops all running services in a Docker Compose project while preserving
|
|
1348
|
+
* Stops all running services in a Docker Compose project while preserving
|
|
1349
|
+
container configurations and data volumes.
|
|
1323
1350
|
|
|
1324
1351
|
This operation gracefully shuts down containers in reverse dependency order.
|
|
1325
1352
|
|
|
@@ -1340,11 +1367,13 @@ Use this to temporarily halt a project without removing data or configurations.
|
|
|
1340
1367
|
};
|
|
1341
1368
|
|
|
1342
1369
|
/**
|
|
1343
|
-
* Updates a Docker Compose project by pulling the latest image versions and
|
|
1370
|
+
* Updates a Docker Compose project by pulling the latest image versions and
|
|
1371
|
+
recreating containers with new configurations.
|
|
1344
1372
|
|
|
1345
1373
|
This operation preserves data volumes while applying changes from the compose file.
|
|
1346
1374
|
|
|
1347
|
-
Use this to deploy application updates, apply configuration changes, or
|
|
1375
|
+
Use this to deploy application updates, apply configuration changes, or
|
|
1376
|
+
refresh container images to their latest versions.
|
|
1348
1377
|
*/
|
|
1349
1378
|
"VPS_updateProjectV1": {
|
|
1350
1379
|
params: {
|
|
@@ -1465,7 +1494,8 @@ Use this endpoint to set up new firewall configurations for VPS security.
|
|
|
1465
1494
|
/**
|
|
1466
1495
|
* Update a specific firewall rule from a specified firewall.
|
|
1467
1496
|
|
|
1468
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1497
|
+
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1498
|
+
and will have to be synced again manually.
|
|
1469
1499
|
|
|
1470
1500
|
Use this endpoint to modify existing firewall rules.
|
|
1471
1501
|
*/
|
|
@@ -1502,8 +1532,9 @@ Use this endpoint to modify existing firewall rules.
|
|
|
1502
1532
|
/**
|
|
1503
1533
|
* Delete a specific firewall rule from a specified firewall.
|
|
1504
1534
|
|
|
1505
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1506
|
-
|
|
1535
|
+
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1536
|
+
and will have to be synced again manually.
|
|
1537
|
+
|
|
1507
1538
|
Use this endpoint to remove specific firewall rules.
|
|
1508
1539
|
*/
|
|
1509
1540
|
"VPS_deleteFirewallRuleV1": {
|
|
@@ -1523,9 +1554,11 @@ Use this endpoint to remove specific firewall rules.
|
|
|
1523
1554
|
/**
|
|
1524
1555
|
* Create new firewall rule for a specified firewall.
|
|
1525
1556
|
|
|
1526
|
-
By default, the firewall drops all incoming traffic,
|
|
1557
|
+
By default, the firewall drops all incoming traffic,
|
|
1558
|
+
which means you must add accept rules for all ports you want to use.
|
|
1527
1559
|
|
|
1528
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1560
|
+
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1561
|
+
and will have to be synced again manually.
|
|
1529
1562
|
|
|
1530
1563
|
Use this endpoint to add new security rules to firewalls.
|
|
1531
1564
|
*/
|
|
@@ -1647,7 +1680,8 @@ Use this endpoint to view available automation scripts for VPS deployment.
|
|
|
1647
1680
|
/**
|
|
1648
1681
|
* Add a new post-install script to your account, which can then be used after virtual machine installation.
|
|
1649
1682
|
|
|
1650
|
-
The script contents will be saved to the file `/post_install` with executable attribute set
|
|
1683
|
+
The script contents will be saved to the file `/post_install` with executable attribute set
|
|
1684
|
+
and will be executed once virtual machine is installed.
|
|
1651
1685
|
The output of the script will be redirected to `/post_install.log`. Maximum script size is 48KB.
|
|
1652
1686
|
|
|
1653
1687
|
Use this endpoint to create automation scripts for VPS setup tasks.
|
|
@@ -1787,9 +1821,10 @@ Use this endpoint to monitor specific VPS operation status and details.
|
|
|
1787
1821
|
/**
|
|
1788
1822
|
* Retrieve actions performed on a specified virtual machine.
|
|
1789
1823
|
|
|
1790
|
-
Actions are operations or events that have been executed on the virtual
|
|
1791
|
-
|
|
1792
|
-
|
|
1824
|
+
Actions are operations or events that have been executed on the virtual
|
|
1825
|
+
machine, such as starting, stopping, or modifying the machine. This endpoint
|
|
1826
|
+
allows you to view the history of these actions, providing details about
|
|
1827
|
+
each action, such as the action name, timestamp, and status.
|
|
1793
1828
|
|
|
1794
1829
|
Use this endpoint to view VPS operation history and troubleshoot issues.
|
|
1795
1830
|
*/
|
|
@@ -1936,7 +1971,8 @@ Use this endpoint to view available VPS instances.
|
|
|
1936
1971
|
/**
|
|
1937
1972
|
* Purchase and setup a new virtual machine.
|
|
1938
1973
|
|
|
1939
|
-
If virtual machine setup fails for any reason, login to
|
|
1974
|
+
If virtual machine setup fails for any reason, login to
|
|
1975
|
+
[hPanel](https://hpanel.hostinger.com/) and complete the setup manually.
|
|
1940
1976
|
|
|
1941
1977
|
If no payment method is provided, your default payment method will be used automatically.
|
|
1942
1978
|
|
|
@@ -1965,10 +2001,12 @@ Use this endpoint to create new VPS instances.
|
|
|
1965
2001
|
};
|
|
1966
2002
|
|
|
1967
2003
|
/**
|
|
1968
|
-
* Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner
|
|
2004
|
+
* Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner
|
|
2005
|
+
installed on a specified virtual machine.
|
|
1969
2006
|
|
|
1970
|
-
The scan metrics provide detailed information about malware scans performed
|
|
1971
|
-
|
|
2007
|
+
The scan metrics provide detailed information about malware scans performed
|
|
2008
|
+
by Monarx, including number of scans, detected threats, and other relevant
|
|
2009
|
+
statistics. This information is useful for monitoring security status of the
|
|
1972
2010
|
virtual machine and assessing effectiveness of the malware scanner.
|
|
1973
2011
|
|
|
1974
2012
|
Use this endpoint to monitor VPS security scan results and threat detection.
|
|
@@ -1986,8 +2024,10 @@ Use this endpoint to monitor VPS security scan results and threat detection.
|
|
|
1986
2024
|
/**
|
|
1987
2025
|
* Install the Monarx malware scanner on a specified virtual machine.
|
|
1988
2026
|
|
|
1989
|
-
[Monarx](https://www.monarx.com/) is a security tool designed to detect and
|
|
1990
|
-
|
|
2027
|
+
[Monarx](https://www.monarx.com/) is a security tool designed to detect and
|
|
2028
|
+
prevent malware infections on virtual machines. By installing Monarx, users
|
|
2029
|
+
can enhance the security of their virtual machines, ensuring that they are
|
|
2030
|
+
protected against malicious software.
|
|
1991
2031
|
|
|
1992
2032
|
Use this endpoint to enable malware protection on VPS instances.
|
|
1993
2033
|
*/
|
|
@@ -2051,7 +2091,8 @@ Use this endpoint to monitor VPS performance and resource utilization over time.
|
|
|
2051
2091
|
/**
|
|
2052
2092
|
* Set nameservers for a specified virtual machine.
|
|
2053
2093
|
|
|
2054
|
-
Be aware, that improper nameserver configuration can lead to the virtual
|
|
2094
|
+
Be aware, that improper nameserver configuration can lead to the virtual
|
|
2095
|
+
machine being unable to resolve domain names.
|
|
2055
2096
|
|
|
2056
2097
|
Use this endpoint to configure custom DNS resolvers for VPS instances.
|
|
2057
2098
|
*/
|
|
@@ -2103,7 +2144,8 @@ Use this endpoint to configure reverse DNS lookup for VPS IP addresses.
|
|
|
2103
2144
|
/**
|
|
2104
2145
|
* Delete a PTR (Pointer) record for a specified virtual machine.
|
|
2105
2146
|
|
|
2106
|
-
Once deleted, reverse DNS lookups to the virtual machine's IP address will
|
|
2147
|
+
Once deleted, reverse DNS lookups to the virtual machine's IP address will
|
|
2148
|
+
no longer return the previously configured hostname.
|
|
2107
2149
|
|
|
2108
2150
|
Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
2109
2151
|
*/
|
|
@@ -2125,7 +2167,8 @@ Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
|
2125
2167
|
* Set panel password for a specified virtual machine.
|
|
2126
2168
|
|
|
2127
2169
|
If virtual machine does not use panel OS, the request will still be processed without any effect.
|
|
2128
|
-
Requirements for password are same as in the [recreate virtual machine
|
|
2170
|
+
Requirements for password are same as in the [recreate virtual machine
|
|
2171
|
+
endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).
|
|
2129
2172
|
|
|
2130
2173
|
Use this endpoint to configure control panel access credentials for VPS instances.
|
|
2131
2174
|
*/
|
|
@@ -2188,7 +2231,8 @@ Use this endpoint to exit system rescue mode and return VPS to normal operation.
|
|
|
2188
2231
|
/**
|
|
2189
2232
|
* Recreate a virtual machine from scratch.
|
|
2190
2233
|
|
|
2191
|
-
The recreation process involves reinstalling the operating system and
|
|
2234
|
+
The recreation process involves reinstalling the operating system and
|
|
2235
|
+
resetting the virtual machine to its initial state.
|
|
2192
2236
|
Snapshots, if there are any, will be deleted.
|
|
2193
2237
|
|
|
2194
2238
|
## Password Requirements
|
|
@@ -2215,11 +2259,14 @@ Use this endpoint to completely rebuild VPS instances with fresh OS installation
|
|
|
2215
2259
|
*/
|
|
2216
2260
|
template_id: number;
|
|
2217
2261
|
/**
|
|
2218
|
-
* Root password for the virtual machine. If not provided, random password will be generated.
|
|
2262
|
+
* Root password for the virtual machine. If not provided, random password will be generated.
|
|
2263
|
+
Password will not be shown in the response.
|
|
2219
2264
|
*/
|
|
2220
2265
|
password?: string;
|
|
2221
2266
|
/**
|
|
2222
|
-
* Panel password for the panel-based OS template. If not provided, random password will be generated.
|
|
2267
|
+
* Panel password for the panel-based OS template. If not provided, random password will be generated.
|
|
2268
|
+
If OS does not support panel_password this field will be ignored.
|
|
2269
|
+
Password will not be shown in the response.
|
|
2223
2270
|
*/
|
|
2224
2271
|
panel_password?: string;
|
|
2225
2272
|
/**
|
|
@@ -2250,7 +2297,8 @@ Use this endpoint to reboot VPS instances.
|
|
|
2250
2297
|
/**
|
|
2251
2298
|
* Set root password for a specified virtual machine.
|
|
2252
2299
|
|
|
2253
|
-
Requirements for password are same as in the [recreate virtual machine
|
|
2300
|
+
Requirements for password are same as in the [recreate virtual machine
|
|
2301
|
+
endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).
|
|
2254
2302
|
|
|
2255
2303
|
Use this endpoint to update administrator credentials for VPS instances.
|
|
2256
2304
|
*/
|
|
@@ -2292,7 +2340,8 @@ Use this endpoint to configure and initialize purchased VPS instances.
|
|
|
2292
2340
|
*/
|
|
2293
2341
|
post_install_script_id?: number;
|
|
2294
2342
|
/**
|
|
2295
|
-
* Password for the virtual machine. If not provided, random password will be generated.
|
|
2343
|
+
* Password for the virtual machine. If not provided, random password will be generated.
|
|
2344
|
+
Password will not be shown in the response.
|
|
2296
2345
|
*/
|
|
2297
2346
|
password?: string;
|
|
2298
2347
|
/**
|
|
@@ -2378,7 +2427,8 @@ Use this endpoint to remove VPS snapshots.
|
|
|
2378
2427
|
/**
|
|
2379
2428
|
* Restore a specified virtual machine to a previous state using a snapshot.
|
|
2380
2429
|
|
|
2381
|
-
Restoring from a snapshot allows users to revert the virtual machine to that state,
|
|
2430
|
+
Restoring from a snapshot allows users to revert the virtual machine to that state,
|
|
2431
|
+
which is useful for system recovery, undoing changes, or testing.
|
|
2382
2432
|
|
|
2383
2433
|
Use this endpoint to revert VPS instances to previous saved states.
|
|
2384
2434
|
*/
|