SiteHost API: /cloud/db/list

/cloud /db /list_all

GET https://api.sitehost.nz/1.1/cloud/db/list_all.json

Returns a list of all databases.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the databases belong to.Example: 1
filters[server_name]	string		Show only databases residing on a specific server.Example: ch-servername
filters[mysql_host]	string		Show only databases that reside on the specified MySQL host. Valid options (if they are running) are mysql56, mysql57, and mysql8.Example: mysql57
filters[db_name]	string		Show only databases whose name matches the specified string.Example: dbname
filters[sort_by]	string		The field name to sort the results by.
filters[sort_dir]	string		The direction to sort in. Valid options are ASC and DESC
filters[page_size]	integer		The number of items to return per page.
filters[page_number]	integer		The page number to return.

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.1/cloud/db/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[db_name]=dbname", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/cloud/db/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[db_name]=dbname");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

require 'net/http'
require 'uri'

uri = URI.parse("https://api.sitehost.nz/1.1/cloud/db/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[db_name]=dbname")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri)

response = http.request(request)

import requests

uri = 'https://api.sitehost.nz/1.1/cloud/db/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[db_name]=dbname'

response = requests.get(uri)

Response

200:

application/json

{
    "return": {
        "total_items": 2,
        "current_items": 2,
        "current_page": 1,
        "total_pages": 1,
        "data": [
            {
                "id": "1272",
                "db_name": "database-name",
                "mysql_host": "mysql57",
                "size": "87187456",
                "client_id": "1",
                "server_id": "1",
                "pending": null,
                "is_missing": "0",
                "date_added": "0000-00-00 00:00:00",
                "date_updated": "2020-10-22 16:30:33",
                "server_name": "ch-servername",
                "server_label": "My Server",
                "server_ip": "192.168.1.1",
                "server_owner": true,
                "container": "cc12345678"
            },
            {
                "id": "1320",
                "db_name": "another-database-name",
                "mysql_host": "mysql8",
                "size": null,
                "client_id": "1",
                "server_id": "1",
                "pending": "adding:3773333",
                "is_missing": "0",
                "date_added": "0000-00-00 00:00:00",
                "date_updated": "2020-10-21 14:52:10",
                "server_name": "ch-servername",
                "server_label": "My Server",
                "server_ip": "192.168.1.1",
                "server_owner": true,
                "container": "cc87654321"
            }
        ]
    },
    "msg": "Successful",
    "status": true
}