CrownPanel CLI App
CrownPanel API
CrownPanel CLI App
CrownPanel API
CrownPanel API Overview

CrownPanel's API allows you to manage your VPS programmatically - including actions like power control, hostname changes, snapshot management, and more.

You can use the API with:

  • PHP scripts
  • CLI tools like curl
  • Monitoring systems
  • Custom control panels or dashboards

Ideal for automation, integration into management panels, or performing bulk operations across multiple VPS instances.

⚡ Boot VPS

Use this API to boot (power on) a VPS that is currently powered off.

This is useful when you want to remotely start your server after it's been shut down or stopped.

Key(s) and variable(s) required for this call

Key Variable Description Required
API_KEY YOUR_API_KEY Replace YOUR_API_KEY with your actual API key provided in "Account Settings", under the API section ✅ Yes
QUERY boot Fixed value: must be "boot". ✅ Yes
VMID YOUR_VMID The VMID of your VPS. Retrieve it from the List All VPSes API Call. ✅ Yes

Example Responses

✅ If YOUR_API_KEY, QUERY & YOUR_VMID are valid:

Success Output

{"query_status": "Success", "query": "boot", "query_result": "Success, Task Added. Please wait for 1-2 minutes for it to complete."}

❌ If API_KEY, QUERY, or VMID are invalid:

Error Output

{"query_status": "Error", "query": "", "query_result": ""}

CURL Example

curl -d "API_KEY=YOUR_API_KEY&QUERY=boot&VMID=YOUR_VMID" -X POST https://api.crownpanel.com

🌐 Other Language Examples

If you prefer to use another language or environment, here are examples for PHP, Python and Node.js:

PHP Example
<?php
$url = "https://api.crownpanel.com";

$post = [
    'API_KEY' => 'YOUR_API_KEY',
    'QUERY'   => 'boot',
    'VMID'    => 'YOUR_VMID',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
$response = curl_exec($ch);
var_export($response);
?>
Python Example

⚙️ Install (only once): Required to install necessary libraries before running the code.

pip install requests
import requests

url = "https://api.crownpanel.com"
data = {
    "API_KEY": "YOUR_API_KEY",
    "QUERY": "boot",
    "VMID": "YOUR_VMID"
}

response = requests.post(url, data=data)
print(response.text)
Node.js Example

⚙️ Install (only once): Required to install necessary libraries before running the code.

npm install axios
const axios = require('axios');

const data = new URLSearchParams({
  API_KEY: 'YOUR_API_KEY',
  QUERY: 'boot',
  VMID: 'YOUR_VMID'
});

axios.post('https://api.crownpanel.com', data)
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

🔗 Related API Calls

Need help? Visit our Support Portal or reach out via our live chat.

ON THIS PAGE