hostinger-api-mcp 0.1.28 → 0.1.37
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 +107 -82
- package/package.json +1 -1
- package/server.js +42 -96
- package/server.ts +42 -96
- package/types.d.ts +107 -90
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: {
|
|
@@ -1124,9 +1108,10 @@ Segments are used to organize and group contacts based on specific criteria.
|
|
|
1124
1108
|
|
|
1125
1109
|
This endpoint allows you to create a new contact with basic information like name, email, and surname.
|
|
1126
1110
|
|
|
1127
|
-
If double opt-in is enabled, the contact will be created with a pending status
|
|
1111
|
+
If double opt-in is enabled, the contact will be created with a pending status
|
|
1112
|
+
and a confirmation email will be sent.
|
|
1128
1113
|
*/
|
|
1129
|
-
"
|
|
1114
|
+
"reach_createNewContactsV1": {
|
|
1130
1115
|
params: {
|
|
1131
1116
|
/**
|
|
1132
1117
|
* Profile uuid parameter
|
|
@@ -1177,7 +1162,8 @@ Use this endpoint to view location options before deploying VPS instances.
|
|
|
1177
1162
|
/**
|
|
1178
1163
|
* Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine.
|
|
1179
1164
|
|
|
1180
|
-
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.
|
|
1181
1167
|
|
|
1182
1168
|
Use this to monitor the health and state of all services within your Docker Compose project.
|
|
1183
1169
|
*/
|
|
@@ -1196,7 +1182,8 @@ Use this to monitor the health and state of all services within your Docker Comp
|
|
|
1196
1182
|
};
|
|
1197
1183
|
|
|
1198
1184
|
/**
|
|
1199
|
-
* 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.
|
|
1200
1187
|
|
|
1201
1188
|
This endpoint provides the full configuration and state details of a specific Docker Compose project.
|
|
1202
1189
|
|
|
@@ -1241,9 +1228,11 @@ Use this when you want to permanently remove a project and free up system resour
|
|
|
1241
1228
|
/**
|
|
1242
1229
|
* Retrieves a list of all Docker Compose projects currently deployed on the virtual machine.
|
|
1243
1230
|
|
|
1244
|
-
This endpoint returns basic information about each project including name,
|
|
1245
|
-
|
|
1246
|
-
|
|
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.
|
|
1247
1236
|
|
|
1248
1237
|
Use this to get an overview of all Docker projects on your VPS instance.
|
|
1249
1238
|
*/
|
|
@@ -1260,8 +1249,10 @@ Use this to get an overview of all Docker projects on your VPS instance.
|
|
|
1260
1249
|
/**
|
|
1261
1250
|
* Deploy new project from docker-compose.yaml contents or download contents from URL.
|
|
1262
1251
|
|
|
1263
|
-
URL can be Github repository url in format https://github.com/[user]/[repo]
|
|
1264
|
-
|
|
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.
|
|
1265
1256
|
|
|
1266
1257
|
If project with the same name already exists, existing project will be replaced.
|
|
1267
1258
|
*/
|
|
@@ -1293,7 +1284,8 @@ If project with the same name already exists, existing project will be replaced.
|
|
|
1293
1284
|
This endpoint returns recent log output from each container, organized by service name with timestamps.
|
|
1294
1285
|
The response contains the last 300 log entries across all services.
|
|
1295
1286
|
|
|
1296
|
-
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.
|
|
1297
1289
|
*/
|
|
1298
1290
|
"VPS_getProjectLogsV1": {
|
|
1299
1291
|
params: {
|
|
@@ -1310,7 +1302,8 @@ Use this for debugging, monitoring application behavior, and troubleshooting iss
|
|
|
1310
1302
|
};
|
|
1311
1303
|
|
|
1312
1304
|
/**
|
|
1313
|
-
* 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.
|
|
1314
1307
|
|
|
1315
1308
|
This operation preserves data volumes and network configurations while refreshing the running containers.
|
|
1316
1309
|
|
|
@@ -1352,7 +1345,8 @@ Use this to resume a project that was previously stopped or to start services af
|
|
|
1352
1345
|
};
|
|
1353
1346
|
|
|
1354
1347
|
/**
|
|
1355
|
-
* 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.
|
|
1356
1350
|
|
|
1357
1351
|
This operation gracefully shuts down containers in reverse dependency order.
|
|
1358
1352
|
|
|
@@ -1373,11 +1367,13 @@ Use this to temporarily halt a project without removing data or configurations.
|
|
|
1373
1367
|
};
|
|
1374
1368
|
|
|
1375
1369
|
/**
|
|
1376
|
-
* 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.
|
|
1377
1372
|
|
|
1378
1373
|
This operation preserves data volumes while applying changes from the compose file.
|
|
1379
1374
|
|
|
1380
|
-
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.
|
|
1381
1377
|
*/
|
|
1382
1378
|
"VPS_updateProjectV1": {
|
|
1383
1379
|
params: {
|
|
@@ -1498,7 +1494,8 @@ Use this endpoint to set up new firewall configurations for VPS security.
|
|
|
1498
1494
|
/**
|
|
1499
1495
|
* Update a specific firewall rule from a specified firewall.
|
|
1500
1496
|
|
|
1501
|
-
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.
|
|
1502
1499
|
|
|
1503
1500
|
Use this endpoint to modify existing firewall rules.
|
|
1504
1501
|
*/
|
|
@@ -1535,8 +1532,9 @@ Use this endpoint to modify existing firewall rules.
|
|
|
1535
1532
|
/**
|
|
1536
1533
|
* Delete a specific firewall rule from a specified firewall.
|
|
1537
1534
|
|
|
1538
|
-
Any virtual machine that has this firewall activated will lose sync with the firewall
|
|
1539
|
-
|
|
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
|
+
|
|
1540
1538
|
Use this endpoint to remove specific firewall rules.
|
|
1541
1539
|
*/
|
|
1542
1540
|
"VPS_deleteFirewallRuleV1": {
|
|
@@ -1556,9 +1554,11 @@ Use this endpoint to remove specific firewall rules.
|
|
|
1556
1554
|
/**
|
|
1557
1555
|
* Create new firewall rule for a specified firewall.
|
|
1558
1556
|
|
|
1559
|
-
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.
|
|
1560
1559
|
|
|
1561
|
-
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.
|
|
1562
1562
|
|
|
1563
1563
|
Use this endpoint to add new security rules to firewalls.
|
|
1564
1564
|
*/
|
|
@@ -1680,7 +1680,8 @@ Use this endpoint to view available automation scripts for VPS deployment.
|
|
|
1680
1680
|
/**
|
|
1681
1681
|
* Add a new post-install script to your account, which can then be used after virtual machine installation.
|
|
1682
1682
|
|
|
1683
|
-
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.
|
|
1684
1685
|
The output of the script will be redirected to `/post_install.log`. Maximum script size is 48KB.
|
|
1685
1686
|
|
|
1686
1687
|
Use this endpoint to create automation scripts for VPS setup tasks.
|
|
@@ -1820,9 +1821,10 @@ Use this endpoint to monitor specific VPS operation status and details.
|
|
|
1820
1821
|
/**
|
|
1821
1822
|
* Retrieve actions performed on a specified virtual machine.
|
|
1822
1823
|
|
|
1823
|
-
Actions are operations or events that have been executed on the virtual
|
|
1824
|
-
|
|
1825
|
-
|
|
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.
|
|
1826
1828
|
|
|
1827
1829
|
Use this endpoint to view VPS operation history and troubleshoot issues.
|
|
1828
1830
|
*/
|
|
@@ -1969,7 +1971,8 @@ Use this endpoint to view available VPS instances.
|
|
|
1969
1971
|
/**
|
|
1970
1972
|
* Purchase and setup a new virtual machine.
|
|
1971
1973
|
|
|
1972
|
-
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.
|
|
1973
1976
|
|
|
1974
1977
|
If no payment method is provided, your default payment method will be used automatically.
|
|
1975
1978
|
|
|
@@ -1998,10 +2001,12 @@ Use this endpoint to create new VPS instances.
|
|
|
1998
2001
|
};
|
|
1999
2002
|
|
|
2000
2003
|
/**
|
|
2001
|
-
* 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.
|
|
2002
2006
|
|
|
2003
|
-
The scan metrics provide detailed information about malware scans performed
|
|
2004
|
-
|
|
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
|
|
2005
2010
|
virtual machine and assessing effectiveness of the malware scanner.
|
|
2006
2011
|
|
|
2007
2012
|
Use this endpoint to monitor VPS security scan results and threat detection.
|
|
@@ -2019,8 +2024,10 @@ Use this endpoint to monitor VPS security scan results and threat detection.
|
|
|
2019
2024
|
/**
|
|
2020
2025
|
* Install the Monarx malware scanner on a specified virtual machine.
|
|
2021
2026
|
|
|
2022
|
-
[Monarx](https://www.monarx.com/) is a security tool designed to detect and
|
|
2023
|
-
|
|
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.
|
|
2024
2031
|
|
|
2025
2032
|
Use this endpoint to enable malware protection on VPS instances.
|
|
2026
2033
|
*/
|
|
@@ -2084,7 +2091,8 @@ Use this endpoint to monitor VPS performance and resource utilization over time.
|
|
|
2084
2091
|
/**
|
|
2085
2092
|
* Set nameservers for a specified virtual machine.
|
|
2086
2093
|
|
|
2087
|
-
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.
|
|
2088
2096
|
|
|
2089
2097
|
Use this endpoint to configure custom DNS resolvers for VPS instances.
|
|
2090
2098
|
*/
|
|
@@ -2136,7 +2144,8 @@ Use this endpoint to configure reverse DNS lookup for VPS IP addresses.
|
|
|
2136
2144
|
/**
|
|
2137
2145
|
* Delete a PTR (Pointer) record for a specified virtual machine.
|
|
2138
2146
|
|
|
2139
|
-
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.
|
|
2140
2149
|
|
|
2141
2150
|
Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
2142
2151
|
*/
|
|
@@ -2158,7 +2167,8 @@ Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
|
2158
2167
|
* Set panel password for a specified virtual machine.
|
|
2159
2168
|
|
|
2160
2169
|
If virtual machine does not use panel OS, the request will still be processed without any effect.
|
|
2161
|
-
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).
|
|
2162
2172
|
|
|
2163
2173
|
Use this endpoint to configure control panel access credentials for VPS instances.
|
|
2164
2174
|
*/
|
|
@@ -2221,7 +2231,8 @@ Use this endpoint to exit system rescue mode and return VPS to normal operation.
|
|
|
2221
2231
|
/**
|
|
2222
2232
|
* Recreate a virtual machine from scratch.
|
|
2223
2233
|
|
|
2224
|
-
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.
|
|
2225
2236
|
Snapshots, if there are any, will be deleted.
|
|
2226
2237
|
|
|
2227
2238
|
## Password Requirements
|
|
@@ -2248,11 +2259,14 @@ Use this endpoint to completely rebuild VPS instances with fresh OS installation
|
|
|
2248
2259
|
*/
|
|
2249
2260
|
template_id: number;
|
|
2250
2261
|
/**
|
|
2251
|
-
* 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.
|
|
2252
2264
|
*/
|
|
2253
2265
|
password?: string;
|
|
2254
2266
|
/**
|
|
2255
|
-
* 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.
|
|
2256
2270
|
*/
|
|
2257
2271
|
panel_password?: string;
|
|
2258
2272
|
/**
|
|
@@ -2283,7 +2297,8 @@ Use this endpoint to reboot VPS instances.
|
|
|
2283
2297
|
/**
|
|
2284
2298
|
* Set root password for a specified virtual machine.
|
|
2285
2299
|
|
|
2286
|
-
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).
|
|
2287
2302
|
|
|
2288
2303
|
Use this endpoint to update administrator credentials for VPS instances.
|
|
2289
2304
|
*/
|
|
@@ -2325,7 +2340,8 @@ Use this endpoint to configure and initialize purchased VPS instances.
|
|
|
2325
2340
|
*/
|
|
2326
2341
|
post_install_script_id?: number;
|
|
2327
2342
|
/**
|
|
2328
|
-
* 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.
|
|
2329
2345
|
*/
|
|
2330
2346
|
password?: string;
|
|
2331
2347
|
/**
|
|
@@ -2411,7 +2427,8 @@ Use this endpoint to remove VPS snapshots.
|
|
|
2411
2427
|
/**
|
|
2412
2428
|
* Restore a specified virtual machine to a previous state using a snapshot.
|
|
2413
2429
|
|
|
2414
|
-
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.
|
|
2415
2432
|
|
|
2416
2433
|
Use this endpoint to revert VPS instances to previous saved states.
|
|
2417
2434
|
*/
|