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 Network Information

    Use this API call to retrieve the list of IP addresses assigned to your VPS - including IPv4 and IPv6 addresses, gateways, and netmasks.

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

    KeyVariableDescriptionRequired
    API_KEYYOUR_API_KEYReplace YOUR_API_KEY with your actual API key provided in "Account Settings", under the API section.✅ Yes
    QUERYlist_ip_addressesFixed value: "list_ip_addresses"✅ Yes
    VMIDYOUR_VMIDReplace YOUR_VMID with your VPS VMID provided by "List All VPS" API Query✅ Yes

    Response examples

    ✅ If YOUR_API_KEY, QUERY & YOUR_VMID parameters are valid, you would get the following output,

    Success Output

    {"ip_address":"www.xxx.yyy.zzz","ip_address_type":"IPv4","ip_address_gateway":"www.xxx.yyy.zzz","ip_address_netmask":"255.255.255.192"},{"ip_address":"aaa:bbb:ccc:ddd::/64","ip_address_type":"IPv6","ip_address_gateway":"aaa:bbb:ccc::d","ip_address_netmask":"/48"}

    ❌ If YOUR_API_KEY or QUERY or YOUR_VMID are invalid, you would get the following output,

    Error Output

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

    CURL Example

    curl -d "API_KEY=API-KEY-HERE&QUERY=list_ip_addresses&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'    => 'list_ip_addresses',
'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": "list_ip_addresses",
    "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: 'list_ip_addresses',
  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.