CloudatCost API v1

URL

https://panel.cloudatcost.com/api/v1/

Instructions

Sign into your account at https://panel.cloudatcost.com
Click 'settings'
Generate an api key and insert IP information into your account settings
- For access from multiple IP's, comma delimitate them
Use curl to access the panel api via the IP documented as well as key and login username/email

HTTP response codes

200 Success
400 Invalid api URL
403 Invalid or missing api key
412 Request failed
500 Internal server error
503 Rate limit hit

Function list

/api/v1/listservers.php
/api/v1/listtemplates.php
/api/v1/listtasks.php
/api/v1/powerop.php
/api/v1/renameserver.php
/api/v1/rdns.php
/api/v1/console.php
/api/v1/runmode.php
/api/v1/cloudpro/build.php
/api/v1/cloudpro/delete.php
/api/v1/cloudpro/resources.php

Standard response

Usual response to each query:

Success:

{
  "status": "ok",
    "time": 1425064819,
    "id": "90000",
    "data": []
}

Error:

{
  "status": "error",
    "time": 1425064819,
    "error": 104,
    "error_description":"invalid ip address connection"
}

List servers

List all servers on the account

REQUEST

GET https://panel.cloudatcost.com/api/v1/listservers.php

PARAMS

key = KEY

EXAMPLE

curl https://panel.cloudatcost.com/api/v1/listservers.php?key=KEY&login=example@example.com

Output:

{
  "status": "ok",
    "time": 1425064819,
    "id": "90000",
    "data": [
    {
      "id": "2402939",
      "CustID": "90001",
      "packageid": "21579",
      "servername": "localhost",
      "lable": "api-test",
      "label": "api-test",
      "vmname": "c90001-iOD-848113",
      "ip": "1.2.3.4",
      "netmask": "255.255.255.0",
      "gateway": "1.2.3.1",
      "hostname": "c9000-iOD-123.cloudatcost.com",
      "rootpass": "password",
      "vncport": "45148",
      "vncpass": "vnc_pass",
      "servertype": "Custom",
      "template": "Microsoft Windows 7 (64-bit)",
      "cpu": "4",
      "cpuusage": "261",
      "ram": "4096",
      "ramusage": "3556.202",
      "storage": "69",
      "hdusage": "0.000434688",
      "sdate": "01\/26\/2014",
      "status": "Powered On",
      "panel_note": "",
      "mode": "Normal",
      "uid": "619712052",
      "sid": "240294",
      "rdns":"c90001-iOD-848113.cloudatcost.com",
      "rdnsdefault":"ptr-not-configured.cloudatcost"
    }
  ]
}

List templates

List all templates available

REQUEST

GET https://panel.cloudatcost.com/api/v1/listtemplates.php

PARAMS

key = KEY

EXAMPLE

curl https://panel.cloudatcost.com/api/v1/listtemplates.php?key=KEY&login=example@example.com

Output:

{
  "status": "ok",
    "time": 1425326406,
    "data": [
    {
      "id": "26",
      "detail": "CentOS-7-64bit"
    },
    {
      "id": "27",
      "detail": "Ubuntu-14.04.1-LTS-64bit"
    },
    {
      "id": "15",
      "detail": "CentOS 6.5 64bit (LAMP)"
    },
    {
      "id": "21",
      "detail": "Ubuntu 12.10 64bit"
    },
    {
      "id": "23",
      "detail": "Ubuntu 12.04.3 LTS 64bit"
    },
    {
      "id": "24",
      "detail": "Windows 2008 R2 64bit (BigDogs Only)"
    },
    {
      "id": "25",
      "detail": "Windows 2012 R2 64bit (BigDogs Only)"
    },
    {
      "id": "14",
      "detail": "CentOS 6.5 64bit (cPanel-WHM)"
    },
    {
      "id": "13",
      "detail": "CentOS 6.5 64bit"
    },
    {
      "id": "10",
      "detail": "CentOS 6.5 32bit"
    },
    {
      "id": "3",
      "detail": "Debian 7.1 64bit"
    },
    {
      "id": "9",
      "detail": "Windows7 64bit (BigDogs Only)"
    },
    {
      "id": "2",
      "detail": "Ubuntu-13.10-64bit"
    },
    {
      "id": "1",
      "detail": "CentOS 6.4 64bit"
    },
    {
      "id": "28",
      "detail": "Minecraft-CentOS-7-64bit"
    }
  ]
}

List tasks

List all tasks in operation

REQUEST

GET https://panel.cloudatcost.com/api/v1/listtasks.php

PARAMS

key = KEY

EXAMPLE

curl https://panel.cloudatcost.com/api/v1/listtasks.php?key=KEY&login=example@example.com

Output:

{
  "status": "ok",
    "time": 1425504688,
    "api": "v1",
    "cid": "734103810",
    "action": "listtasks",
    "data": [
    {
      "cid": "734103810",
      "idf": "8548136390745",
      "serverid": "0",
      "action": "reset",
      "status": "completed",
      "starttime": "1425504093",
      "finishtime": "1425504094",
      "servername":"c1115850-28047",
      "ip":"1.1.1.1",
      "label":"mysql server",
      "rdns":"c1115850-28047.cloudatcost.com",
      "rdnsdefault":"ptr-not-configured.cloudatcost"
    },
    {
      "cid": "734103810",
      "idf": "2268428551033",
      "serverid": "254513205",
      "action": "reset",
      "status": "pending",
      "starttime": "1425504295",
      "finishtime": "1425504312",
      "servername":"c1115860-28047",
      "ip":"1.1.1.1",
      "label":"centos server",
      "rdns":"c1115860-28047.cloudatcost.com",
      "rdnsdefault":"ptr-not-configured.cloudatcost"
    }
  ]
}

Power operations

Activate server power operations

REQUEST

POST https://panel.cloudatcost.com/api/v1/powerop.php

PARAMS

key = KEY

sid = SERVERID

action = poweron,poweroff,reset

EXAMPLE

curl --data "key=KEY&login=example@example.com&sid=12345&action=reset" https://panel.cloudatcost.com/api/v1/powerop.php

Output:

Success:

{
  "status": "ok",
    "time": 1425504815,
    "api": "v1",
    "serverid": "254513205",
    "action": "reset",
    "taskid": 700420024805,
    "result": "successful"
}

Unsuccessful:

{
  "status": "error",
    "time": 1425505065,
    "error": 105,
    "error_description": "task already running"
}

Run mode

Set the run mode of the server to either 'normal' or 'safe'. Safe automatically turns off the server after 7 days of idle usage. Normal keeps it on indefinitely.

REQUEST

POST https://panel.cloudatcost.com/api/v1/runmode.php

PARAMS

key = KEY

sid = SERVERID

mode = normal/safe

EXAMPLE

curl --data "key=KEY&login=example@example.com&sid=12345&mode=normal" https://panel.cloudatcost.com/api/v1/runmode.php

Output:

Success:

{
  "status": "ok",
    "time": 1425504815,
    "api": "v1",
    "serverid": "254513205",
    "result": "successful"
}

Unsuccessful:

{
  "status": "error",
    "time": 1425505065,
    "error": 109,
    "error_description": "invalid server ID"
}

Rename server

Rename the server label

REQUEST

POST https://panel.cloudatcost.com/api/v1/renameserver.php

PARAMS

key = KEY

sid = SERVERID

name = NAME

EXAMPLE

curl --data "key=KEY&login=example@example.com&sid=12345&name=localhost" https://panel.cloudatcost.com/api/v1/renameserver.php

Output:

Success:

{
  "status": "ok",
    "time": 1425504815,
    "api": "v1",
    "serverid": "254513205",
    "result": "successful"
}

Unsuccessful:

{
  "status": "error",
    "time": 1425505065,
    "error": 109,
    "error_description": "invalid server ID"
}

Modify reverse DNS

Modify the reverse DNS & hostname of the VPS

REQUEST

POST https://panel.cloudatcost.com/api/v1/rdns.php

PARAMS

key = KEY

sid = SERVERID

hostname = HOSTNAME

EXAMPLE

curl --data "key=KEY&login=example@example.com&sid=12345&hostname=localhost.domain.com" https://panel.cloudatcost.com/api/v1/rdns.php

Output:

Success:

{
  "status": "ok",
    "time": 1425504815,
    "api": "v1",
    "serverid": "254513205",
    "result": "successful"
}

Unsuccessful:

{
  "status": "error",
    "time": 1425505065,
    "error": 109,
    "error_description": "invalid domain name"
}

Console

Request URL for console access

REQUEST

POST https://panel.cloudatcost.com/api/v1/console.php

PARAMS

key = KEY

sid = SERVERID

EXAMPLE

curl --data "key=KEY&login=example@example.com&sid=12345" https://panel.cloudatcost.com/api/v1/console.php

Output:

{
  "status": "ok",
  "time": 1425572027,
  "api": "v1",
  "serverid": "1234567890",
  "console": "http:\/\/panel.cloudatcost.com:12345\/console.html?servername=123456&hostname=1.1.1.1&sshkey=123456&sha1hash=aBcDeFgG"
}

CLOUD PRO: Build server

Build a server from available resources

REQUEST

POST https://panel.cloudatcost.com/api/v1/cloudpro/build.php

PARAMS

key = KEY

cpu = 1/2/3/4/5/6/7/8 limit: 16

ram = 1024 (must be multiple of 4. ex. 1024 / 2048 / 3096) limit: 32768

storage = 10/20/30/40/50 ... etc limit: 1000

os = 75 (must be an #id from /v1/listtemplates.php)

EXAMPLE

curl -v --data "key=KEY&login=example@example.com&cpu=1&ram=1024&storage=30&os=75" https://panel.cloudatcost.com/api/v1/cloudpro/build.php

Success output:

{
  "status":"ok",
  "time":1429119324,
  "api":"v1",
  "action":"build",
  "taskid":726492791437,
  "result":"successful"
}

Failure output:

{
  "status":"error",
  "time":1429119324,
  "error":"107",
  "error_description":"Not Enough RAM",
}

Notes:

SSH-key and login details are found within
Build command is added to tasklist and set to pending until complete

CLOUD PRO: Delete server

Delete / terminate server to add resources.

REQUEST

POST https://panel.cloudatcost.com/api/v1/cloudpro/delete.php

PARAMS

key = KEY

sid = SERVERID

EXAMPLE

curl --data "key=KEY&login=example@example.com&sid=12345" https://panel.cloudatcost.com/api/v1/cloudpro/delete.php

Success output:

{
  "status":"ok",
  "time":1429119324,
  "api":"v1",
  "action":"delete",
  "taskid":726492791437,
  "result":"successful"
}

Failure output:

{
  "status":"error",
  "time":1429119324,
  "error":"107",
  "error_description":"Invalid Server Permission"
}

Notes:

Delete command is added to tasklist and set to pending until complete

CLOUD PRO: Resources

Display resources available and resources used in cloud-pro

REQUEST

GET https://panel.cloudatcost.com/api/v1/cloudpro/resources.php

PARAMS

key = KEY

EXAMPLE

curl "https://panel.cloudatcost.com/api/v1/cloudpro/resources.php?key=KEY&login=example@example.com"

Success output:

{
    "status": "ok",
    "time": 1429120346,
    "api": "v1",
    "action": "resources",
    "data": {
        "total": [
            {
                "cpu_total": "8",
                "ram_total": "8192",
                "storage_total": "120"
            }
        ],
        "used": {
            "cpu_used": "3",
            "ram_used": "3072",
            "storage_used": "90"
        }
    }
}