Api MCP Server

🚀 Virtual Machine Management API Documentation

This API documentation provides a detailed guide on how to manage virtual machines through a series of RESTful interfaces. It includes operations such as querying virtual machine status, creating, updating, and deleting virtual machines, as well as managing snapshots.

📚 Documentation

🔍 Get Virtual Machine Status

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}
• Request Method: GET
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to retrieve detailed information about a specified virtual machine, including its running status, configuration, and resource usage.

🆕 Create a New Virtual Machine

• Endpoint: /api/vps/v1/virtual-machines
• Request Method: POST
• Parameters:
  • template_id: Template ID (Required)
  • data_center_id: Data center ID (Required)
  • post_install_script_id: Post - installation script ID
  • password: Virtual machine password. If not provided, a random password will be automatically generated.
  • hostname: Custom hostname
  • install_monarx: Whether to install the Monarx malware scanner (if supported)
  • enable_backups: Whether to enable the weekly backup plan
• Description: This API is used to create a new virtual machine instance. The parameters include template selection, data center location, and script configuration.

📝 Update Virtual Machine Information

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}
• Request Method: PUT
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
  • hostname: New hostname
  • template_id: New template ID
  • data_center_id: New data center ID
  • post_install_script_id: New post - installation script ID
  • password: New password
• Description: This API is used to update the information of a specified virtual machine, including configuration such as hostname, template, and data center.

🗑️ Delete a Virtual Machine

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}
• Request Method: DELETE
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to delete a specified virtual machine instance.

📋 Get All Virtual Machine Lists

• Endpoint: /api/vps/v1/virtual-machines
• Request Method: GET
• Parameters: None
• Description: This API is used to retrieve a list of all virtual machines owned by the user, returning information such as the ID, hostname, and status of each virtual machine.

▶️ Start a Virtual Machine

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/start
• Request Method: POST
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to start a specified virtual machine instance. If the virtual machine is already running, it will have no effect.

⏹️ Stop a Virtual Machine

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/stop
• Request Method: POST
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to stop a specified virtual machine instance. If the virtual machine is already stopped, it will have no effect.

🔄 Restart a Virtual Machine

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/restart
• Request Method: POST
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to restart a specified virtual machine instance, which is equivalent to stopping it completely and then starting it again.

📸 Get Virtual Machine Snapshot

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
• Request Method: GET
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to retrieve snapshot information of a specified virtual machine.

📸 Create a Virtual Machine Snapshot

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
• Request Method: POST
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to create a snapshot of a specified virtual machine, capturing its current state and data. Note: Creating a new snapshot will overwrite the existing snapshot.

🗑️ Delete a Virtual Machine Snapshot

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
• Request Method: DELETE
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to delete a snapshot of a specified virtual machine.

⏮️ Restore a Virtual Machine Snapshot

• Endpoint: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
• Request Method: PUT
• Parameters:
  • virtualMachineId: Virtual machine ID (Required)
• Description: This API is used to restore a virtual machine to a previous state using a snapshot.