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.

ℹī¸ VPS Information

Use this API call to retrieve detailed information about a specific VPS instance on your account.

This can be helpful to confirm VPS specs, location, IP, status, and more.

🔐 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 info Fixed value: must be "info". ✅ Yes
VMID YOUR_VMID The VMID of your VPS. Retrieve it from the List All VPSes API Call. ✅ Yes

Response examples

✅ If your API_KEY is valid, you would get the following output,

Success Output

[{"vmid":"XX","status":"Offline","hostname":"vps.server.com","ipaddress":"XX","location":"Los Angeles, CA","virtualization":"KVM","ram":"1024","hdd":"50","cpu":"2","bandwidth":"1024"}]

❌ If your API_KEY is invalid, you would get the following output,

Error Output

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

CURL Example

curl -d "API_KEY=API-KEY-HERE&QUERY=info&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' => 'info',
'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": "info",
    "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 qs = require('qs');

const data = qs.stringify({
  API_KEY: 'YOUR_API_KEY',
  QUERY: 'info',
  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 use our live chat.

ON THIS PAGE