/cloud/db/get
GET https://api.sitehost.nz/1.3/cloud/db/get.json
Returns information about a database.
Query Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the database belongs to.Example: 1 |
server_name | string | Yes | The server the database belongs to.Example: ch-servername |
mysql_host | string | Yes | The MySQL Integrated Container where the database resides. Valid options (if they are running) are mysql56, mysql57, and mysql8.Example: mysql8 |
database | string | Yes | The name of the database.Example: dbname |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/cloud/db/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&mysql_host=mysql8&database=dbname", false);
xmlHttp.send();
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/cloud/db/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&mysql_host=mysql8&database=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.3/cloud/db/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&mysql_host=mysql8&database=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.3/cloud/db/get.json?apikey=your_key_here&client_id=1&server_name=ch-servername&mysql_host=mysql8&database=dbname'
response = requests.get(uri)
Response
200:application/json
{
"return": {
"db_name": "database-name",
"mysql_host": "mysql8",
"size": null,
"client_id": "1",
"server_id": "1",
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 14:52:10",
"container": "cc12345678",
"server_name": "ch-servername",
"server_label": "My Server",
"grants": [
{
"db_name": "database-name",
"username": "username",
"host": "%",
"mysql_host": "mysql8",
"grants": [],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:52:32"
},
{
"db_name": "database-name",
"username": "username2",
"host": "%",
"mysql_host": "mysql8",
"grants": [
"select",
"insert",
"update",
"delete",
"create",
"drop",
"alter",
"index",
"create view",
"show view",
"lock tables",
"create temporary tables"
],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-22 16:26:49"
},
{
"db_name": "database-name",
"username": "username3",
"host": "%",
"mysql_host": "mysql8",
"grants": [],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-22 16:28:23"
}
]
},
"msg": "Successful",
"status": true
}
"return": {
"db_name": "database-name",
"mysql_host": "mysql8",
"size": null,
"client_id": "1",
"server_id": "1",
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 14:52:10",
"container": "cc12345678",
"server_name": "ch-servername",
"server_label": "My Server",
"grants": [
{
"db_name": "database-name",
"username": "username",
"host": "%",
"mysql_host": "mysql8",
"grants": [],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:52:32"
},
{
"db_name": "database-name",
"username": "username2",
"host": "%",
"mysql_host": "mysql8",
"grants": [
"select",
"insert",
"update",
"delete",
"create",
"drop",
"alter",
"index",
"create view",
"show view",
"lock tables",
"create temporary tables"
],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-22 16:26:49"
},
{
"db_name": "database-name",
"username": "username3",
"host": "%",
"mysql_host": "mysql8",
"grants": [],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-22 16:28:23"
}
]
},
"msg": "Successful",
"status": true
}