hostinger-api-mcp 0.0.1

package/README.md

@@ -0,0 +1,922 @@
+# hostinger-api-mcp
+
+Model Context Protocol (MCP) server for Hostinger API API.
+
+## Description
+
+> [!caution]
+> Currently, this API is in beta stage, meaning that breaking changes, while unlikely, might be introduced.
+> If you encounter any issues or have any feedback, please create an issue on the [Github Repository](https://github.com/hostinger/api/issues).
+# Overview
+The Hostinger API provides a comprehensive set of endpoints that allow developers to interact with Hostinger's services programmatically.
+This API enables you to manage various aspects of your Hostinger account.
+
+The Hostinger API is a (mostly) RESTful API that uses standard HTTP methods and status codes.
+# Authentication
+The Hostinger API uses tokens for authentication. To authenticate your requests, you need to include a valid bearer token in the Authorization header of your HTTP requests:
+```yaml
+Authorization: Bearer YOUR_API_TOKEN
+```
+API tokens for individual users can be created and managed from the [VPS page](https://hpanel.hostinger.com/vps) of the Hostinger Panel.
+Tokens will have same permissions as the owning user. Optionally, tokens can be set to expire after a certain period of time.
+# Rate Limiting
+To ensure fair usage and prevent abuse, the API enforces rate limits on the number of requests that can be made within a certain time period.
+If you exceed the rate limit, you will receive a 429 Too Many Requests response. Rate limit headers are included in the response to help you manage your requests.
+Your IP address might get temporarily blocked if you exceed the rate limit multiple times.
+# Parameters
+All requests sent to API must have the content type `application/json`. `POST`, `PUT`, `PATCH` methods may include a JSON object in the request body. Documentation provides required structure and examples of the object.
+Some endpoints require path parameters. These parameters are included in the URL path and are marked with curly braces.
+# Pagination
+Some endpoints return a large number of items. To make these responses more manageable, the API uses pagination.
+By default, the API returns50 items per page.
+
+ The page number can be specified using the `page` query parameter, for example: `/api/vps/v1/public-keys?page=2`
+# Errors
+The Hostinger API uses standard HTTP status codes to indicate the success or failure of a request.
+In case of an error, the API will return a JSON response with an `error` field, containing a human-readable error message.
+Error responses also contain a `correlation_id` field which can be used to identify the request in case you need to contact support.
+# Change log
+For information on the latest changes to the API, please refer to the [change log](https://github.com/hostinger/api/blob/main/CHANGELOG.md).
+# Support
+If you have any questions, feedback or feature requests, please create an [issue](https://github.com/hostinger/api/issues) or [discussion](https://github.com/hostinger/api/discussions) on the repository.
+
+For any support take a look at our [Github Repository](https://github.com/hostinger/api/), dedicated to the Hostinger API.
+
+## Installation
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Create a `.env` file based on `.env.example`:
+
+```bash
+cp .env.example .env
+```
+
+3. Edit the `.env` file to add your API configuration and authorization details.
+
+## Configuration
+
+The following environment variables can be configured in the `.env` file:
+
+- `API_BASE_URL`: Base URL for the API (required)
+- `SERVER_NAME`: Name of the MCP server (default: "hostinger-api-mcp")
+- `SERVER_VERSION`: Version of the MCP server (default: "0.0.1")
+- `DEBUG`: Enable debug logging (true/false) (default: false)
+
+
+### Authorization Configuration
+
+This server supports the following authorization schemes defined in the OpenAPI specification:
+
+- **apiToken (HTTP Bearer)**: Set environment variable `APITOKEN` with your Bearer token. The token will be sent in the `Authorization` header.
+
+
+
+## Usage
+
+### Running the Server
+
+The server is provided as both JavaScript and TypeScript versions:
+
+```bash
+# Run JavaScript version
+npm start
+
+# Or run TypeScript version (compiles on the fly)
+npm run start:ts
+```
+
+### Building the TypeScript Version
+
+```bash
+npm run build
+cd dist
+node server.js
+```
+
+## Using as an MCP Tool Provider
+
+This server implements the Model Context Protocol (MCP) and can be used with any MCP-compatible consumer, like Claude.js client or other MCP consumers.
+
+Example of connecting to this server from a Claude.js client:
+
+```javascript
+import { MCP } from "claude-js";
+import { createStdio } from "claude-js/mcp";
+
+// Create stdin/stdout transport
+const transport = createStdio({ command: "node path/to/server.js" });
+
+// Connect to the MCP server
+const mcp = new MCP({ transport });
+await mcp.connect();
+
+// List available tools
+const { tools } = await mcp.listTools();
+console.log("Available tools:", tools);
+
+// Call a tool
+const result = await mcp.callTool({
+    id: "TOOL-ID",
+    arguments: { param1: "value1" }
+});
+console.log("Tool result:", result);
+```
+
+## Available Tools
+
+This MCP server provides the following tools:
+
+### billing_getCatalogItemListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of catalog items available for order. 
+
+Prices in catalog items is displayed as cents (without floating point), e.g: float `17.99` is displayed as integer `1799`.
+- **Method**: `GET`
+- **Path**: `/api/billing/v1/catalog`
+
+No parameters required.
+
+### billing_createNewServiceOrderV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint creates a new service order. 
+
+To place order, you need to provide payment method ID and list of price items from the catalog endpoint together with quantity.
+Coupons also can be provided during order creation.
+
+Orders created using this endpoint will be set for automatically renewal.
+- **Method**: `POST`
+- **Path**: `/api/billing/v1/orders`
+
+**Parameters**:
+
+- `payment_method_id`: Payment method ID (required)
+- `items`: items property (required)
+- `coupons`: coupons property 
+
+### billing_setDefaultPaymentMethodV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint sets default payment method for your account.
+- **Method**: `POST`
+- **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
+
+**Parameters**:
+
+- `paymentMethodId`: Payment method ID (required)
+
+### billing_deletePaymentMethodV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a payment method from your account.
+- **Method**: `DELETE`
+- **Path**: `/api/billing/v1/payment-methods/{paymentMethodId}`
+
+**Parameters**:
+
+- `paymentMethodId`: Payment method ID (required)
+
+### billing_getPaymentMethodListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of available payment methods that can be used for placing new orders.
+
+If you want to add new payment method, please use [hPanel](https://hpanel.hostinger.com/billing/payment-methods).
+- **Method**: `GET`
+- **Path**: `/api/billing/v1/payment-methods`
+
+No parameters required.
+
+### billing_cancelSubscriptionV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint cancels a subscription and stops any further billing.
+- **Method**: `DELETE`
+- **Path**: `/api/billing/v1/subscriptions/{subscriptionId}`
+
+**Parameters**:
+
+- `subscriptionId`: Subscription ID (required)
+
+### billing_getSubscriptionListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of all subscriptions associated with your account.
+- **Method**: `GET`
+- **Path**: `/api/billing/v1/subscriptions`
+
+No parameters required.
+
+### domains_getDomainListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of all domains associated with your account.
+- **Method**: `GET`
+- **Path**: `/api/domains/v1/portfolio`
+
+No parameters required.
+
+### VPS_getDataCentersListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of all data centers available.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/data-centers`
+
+No parameters required.
+
+### VPS_activateFirewallV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint activates a firewall for a specified virtual machine. 
+
+Only one firewall can be active for a virtual machine at a time.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_deactivateFirewallV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deactivates a firewall for a specified virtual machine.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_getFirewallV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves firewall by its ID and rules associated with it.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/firewall/{firewallId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+
+### VPS_deleteFirewallV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a specified firewall. 
+
+Any virtual machine that has this firewall activated will automatically have it deactivated.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/firewall/{firewallId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+
+### VPS_getFirewallListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of all firewalls available.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/firewall`
+
+**Parameters**:
+
+- `page`: Page number 
+
+### VPS_createNewFirewallV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint creates a new firewall.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/firewall`
+
+**Parameters**:
+
+- `name`: name property (required)
+
+### VPS_updateFirewallRuleV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint updates a specific firewall rule from a specified firewall.
+
+Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually.
+- **Method**: `PUT`
+- **Path**: `/api/vps/v1/firewall/{firewallId}/rules/{ruleId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+- `ruleId`: Firewall Rule ID (required)
+- `protocol`: protocol property (required)
+- `port`: Port or port range, ex: 1024:2048 (required)
+- `source`: source property (required)
+- `source_detail`: IP range, CIDR, single IP or `any` (required)
+
+### VPS_deleteFirewallRuleV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a specific firewall rule from a specified firewall.
+
+Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/firewall/{firewallId}/rules/{ruleId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+- `ruleId`: Firewall Rule ID (required)
+
+### VPS_createFirewallRuleV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint creates new firewall rule from a specified firewall. 
+By default, the firewall drops all incoming traffic, which means you must add accept rules for all ports you want to use.
+
+Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/firewall/{firewallId}/rules`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+- `protocol`: protocol property (required)
+- `port`: Port or port range, ex: 1024:2048 (required)
+- `source`: source property (required)
+- `source_detail`: IP range, CIDR, single IP or `any` (required)
+
+### VPS_syncFirewallV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint syncs a firewall for a specified virtual machine.
+
+Firewall can loose sync with virtual machine if the firewall has new rules added, removed or updated.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}`
+
+**Parameters**:
+
+- `firewallId`: Firewall ID (required)
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_getPostInstallScriptV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves post-install script by its ID.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
+
+**Parameters**:
+
+- `postInstallScriptId`: Post-install script ID (required)
+
+### VPS_updatePostInstallScriptV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint updates a specific post-install script.
+- **Method**: `PUT`
+- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
+
+**Parameters**:
+
+- `postInstallScriptId`: Post-install script ID (required)
+- `name`: Name of the script (required)
+- `content`: Content of the script (required)
+
+### VPS_deleteAPostInstallScriptV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a post-install script from your account. 
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/post-install-scripts/{postInstallScriptId}`
+
+**Parameters**:
+
+- `postInstallScriptId`: Post-install script ID (required)
+
+### VPS_getPostInstallScriptListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of post-install scripts associated with your account.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/post-install-scripts`
+
+**Parameters**:
+
+- `page`: Page number 
+
+### VPS_createPostInstallScriptV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint allows you to add a new post-install script to your account, 
+which can then be used run after the installation of a virtual machine instance.
+
+The script contents will be saved to the file `/post_install` with executable attribute set and will be executed once virtual machine is installed.
+The output of the script will be redirected to `/post_install.log`. Maximum script size is 48KB. 
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/post-install-scripts`
+
+**Parameters**:
+
+- `name`: Name of the script (required)
+- `content`: Content of the script (required)
+
+### VPS_attachPublicKeyV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint attaches an existing public keys from your account to a specified virtual machine.
+
+Multiple keys can be attached to a single virtual machine.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/public-keys/attach/{virtualMachineId}`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `ids`: Public Key IDs to attach (required)
+
+### VPS_deleteAPublicKeyV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a public key from your account. 
+
+**Deleting public key from account does not remove it from virtual machine** 
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/public-keys/{publicKeyId}`
+
+**Parameters**:
+
+- `publicKeyId`: Public Key ID (required)
+
+### VPS_getPublicKeyListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of public keys associated with your account.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/public-keys`
+
+**Parameters**:
+
+- `page`: Page number 
+
+### VPS_createNewPublicKeyV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint allows you to add a new public key to your account, 
+which can then be attached to virtual machine instances for secure access.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/public-keys`
+
+**Parameters**:
+
+- `name`: name property (required)
+- `key`: key property (required)
+
+### VPS_getTemplateV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves details of a specific OS template for virtual machines.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/templates/{templateId}`
+
+**Parameters**:
+
+- `templateId`: Template ID (required)
+
+### VPS_getTemplateListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of available OS templates for virtual machines.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/templates`
+
+No parameters required.
+
+### VPS_getActionV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves details of a specific action performed on a specified virtual machine. 
+
+This endpoint allows you to view detailed information about a particular action, including the action name, timestamp, and status.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `actionId`: Action ID (required)
+
+### VPS_getActionListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of actions performed on a specified virtual machine.
+
+Actions are operations or events that have been executed on the virtual machine, such as starting, stopping, or modifying 
+the machine. This endpoint allows you to view the history of these actions, providing details about each action, 
+such as the action name, timestamp, and status.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/actions`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `page`: Page number 
+
+### VPS_getAttachedPublicKeysV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of public keys attached to a specified virtual machine.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `page`: Page number 
+
+### VPS_deleteBackupV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a specified backup for a virtual machine.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `backupId`: Backup ID (required)
+
+### VPS_getBackupListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of backups for a specified virtual machine.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups`
+
+**Parameters**:
+
+- `page`: Page number 
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_restoreBackupV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint restores a backup for a specified virtual machine.
+
+The system will then initiate the restore process, which may take some time depending on the size of the backup.
+
+**All data on the virtual machine will be overwritten with the data from the backup.**
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `backupId`: Backup ID (required)
+
+### VPS_setHostnameV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint sets the hostname for a specified virtual machine. 
+Changing hostname does not update PTR record automatically.
+If you want your virtual machine to be reachable by a hostname, 
+you need to point your domain A/AAAA records to virtual machine IP as well.
+- **Method**: `PUT`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/hostname`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `hostname`: hostname property (required)
+
+### VPS_resetHostnameV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint resets the hostname and PTR record of a specified virtual machine to the default value.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/hostname`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_getVirtualMachineV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves detailed information about a specified virtual machine.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_getVirtualMachineListV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a list of all available virtual machines.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines`
+
+No parameters required.
+
+### VPS_getScanMetricsV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves the scan metrics for the [Monarx](https://www.monarx.com/) malware scanner installed on a specified virtual machine.
+The scan metrics provide detailed information about the malware scans performed by Monarx, including the number of scans, 
+detected threats, and other relevant statistics. This information is useful for monitoring the security status of the 
+virtual machine and assessing the effectiveness of the malware scanner.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_installMonarxV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint installs the Monarx malware scanner on a specified virtual machine. 
+
+[Monarx](https://www.monarx.com/) is a security tool designed to detect and prevent malware infections on virtual machines. 
+By installing Monarx, users can enhance the security of their virtual machines, ensuring that they are protected against malicious software.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_uninstallMonarxV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint uninstalls the Monarx malware scanner on a specified virtual machine.
+If Monarx is not installed, the request will still be processed without any effect.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/monarx`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_getMetricsV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves the historical metrics for a specified virtual machine.
+It includes the following metrics: 
+- CPU usage
+- Memory usage
+- Disk usage
+- Network usage
+- Uptime
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/metrics`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `date_from`: the date-time notation as defined by RFC 3339, section 5.6 (required)
+- `date_to`: the date-time notation as defined by RFC 3339, section 5.6 (required)
+
+### VPS_setNameserversV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint sets the nameservers for a specified virtual machine.
+Be aware, that improper nameserver configuration can lead to the virtual machine being unable to resolve domain names.
+- **Method**: `PUT`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `ns1`: ns1 property (required)
+- `ns2`: ns2 property 
+
+### VPS_createPTRRecordV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint creates or updates a PTR (Pointer) record for a specified virtual machine.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_deletePTRRecordV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a PTR (Pointer) record for a specified virtual machine. 
+
+Once deleted, reverse DNS lookups to the virtual machine's IP address will no longer return the previously configured hostname.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/ptr`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_setPanelPasswordV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint sets the panel password for a specified virtual machine. 
+If virtual machine does not use panel OS, the request will still be processed without any effect.
+Requirements for the password is the same as in the [recreate virtual machine endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).
+- **Method**: `PUT`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `password`: Panel password for the virtual machine (required)
+
+### VPS_startRecoveryModeV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint initiates the recovery mode for a specified virtual machine. 
+Recovery mode is a special state that allows users to perform system rescue operations, 
+such as repairing file systems, recovering data, or troubleshooting issues that prevent the virtual machine 
+from booting normally. 
+
+Virtual machine will boot recovery disk image and original disk image will be mounted in `/mnt` directory.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recovery`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `root_password`: Temporary root password for recovery mode (required)
+
+### VPS_stopRecoveryModeV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint stops the recovery mode for a specified virtual machine. 
+If virtual machine is not in recovery mode, this operation will fail.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recovery`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_recreateVirtualMachineV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint will recreate a virtual machine from scratch. 
+The recreation process involves reinstalling the operating system and resetting the virtual machine to its initial state.
+Snapshots, if there are any, will be deleted.
+
+## Password Requirements
+Password will be checked against leaked password databases. 
+Requirements for the password are:
+- At least 8 characters long
+- At least one uppercase letter
+- At least one lowercase letter
+- At least one number
+- Is not leaked publicly
+
+**This operation is irreversible and will result in the loss of all data stored on the virtual machine!**
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/recreate`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `template_id`: Template ID (required)
+- `password`: Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response. 
+- `post_install_script_id`: Post-install script ID 
+
+### VPS_restartVirtualMachineV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint restarts a specified virtual machine. This is equivalent to fully stopping and starting the virtual machine.
+If the virtual machine was stopped, it will be started.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/restart`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_setRootPasswordV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint sets the root password for a specified virtual machine. 
+Requirements for the password is the same as in the [recreate virtual machine endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate).
+- **Method**: `PUT`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/root-password`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `password`: Root password for the virtual machine (required)
+
+### VPS_setupNewVirtualMachineV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint will setup newly purchased virtual machine. Such virtual machines has `initial` state. 
+New virtual machine can be purchased using [`/api/billing/v1/orders`](/#tag/billing-orders/POST/api/billing/v1/orders) endpoint.                        
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/setup`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+- `template_id`: Template ID (required)
+- `data_center_id`: Data center ID (required)
+- `post_install_script_id`: Post-install script ID 
+- `password`: Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response. 
+- `hostname`: Override default hostname of the virtual machine 
+- `install_monarx`: Install Monarx malware scanner (if supported) 
+- `enable_backups`: Enable weekly backup schedule 
+- `ns1`: ns1 property 
+- `ns2`: ns2 property 
+- `public_key`: public_key property 
+
+### VPS_getSnapshotV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint retrieves a snapshot for a specified virtual machine.
+- **Method**: `GET`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_createSnapshotV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint creates a snapshot of a specified virtual machine. 
+A snapshot captures the state and data of the virtual machine at a specific point in time, 
+allowing users to restore the virtual machine to that state if needed. 
+This operation is useful for backup purposes, system recovery, 
+and testing changes without affecting the current state of the virtual machine.
+
+**Creating new snapshot will overwrite the existing snapshot!**
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_deleteSnapshotV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint deletes a snapshot of a specified virtual machine.
+- **Method**: `DELETE`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_restoreSnapshotV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint restores a specified virtual machine to a previous state using a snapshot. 
+Restoring from a snapshot allows users to revert the virtual machine to that state, which is useful for system recovery, undoing changes, or testing.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_startVirtualMachineV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint starts a specified virtual machine. 
+If the virtual machine is already running, the request will still be processed without any effect.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/start`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+### VPS_stopVirtualMachineV1
+
+- **ID**: `undefined`
+- **Description**: This endpoint stops a specified virtual machine. 
+If the virtual machine is already stopped, the request will still be processed without any effect.
+- **Method**: `POST`
+- **Path**: `/api/vps/v1/virtual-machines/{virtualMachineId}/stop`
+
+**Parameters**:
+
+- `virtualMachineId`: Virtual Machine ID (required)
+
+## License
+
+MIT