/cloud/db/user/list_all
GET https://api.sitehost.nz/1.3/cloud/db/user/list_all.json
Returns a list of all database users.
Query Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the database users belong to.Example: 1 |
filters[server_name] | string | Show only users that reside on the specified server.Example: ch-servername | |
filters[mysql_host] | string | Show only users that reside on the specified MySQL host. Valid options (if they are running) are mysql56, mysql57, and mysql8.Example: mysql57 | |
filters[username] | string | Show only users whose name matches the specified string.Example: dbuser | |
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 Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/cloud/db/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[username]=dbuser", false);
xmlHttp.send();
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/cloud/db/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[username]=dbuser");
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/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[username]=dbuser")
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/user/list_all.json?apikey=your_key_here&client_id=1&filters[server_name]=ch-servername&filters[mysql_host]=mysql57&filters[username]=dbuser'
response = requests.get(uri)
Response
200:application/json
{
"return": {
"total_items": 2,
"current_items": 2,
"current_page": 1,
"total_pages": 1,
"data": [
{
"username": "username",
"password": "",
"mysql_host": "mysql8",
"server_id": "1",
"client_id": "1",
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:48:48",
"server_name": "ch-servername",
"server_label": "Server Label",
"grants": [
{
"db_name": "db1",
"username": "username",
"host": "%",
"mysql_host": "mysql8",
"grants": [
"create view",
"select"
],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:48:48"
}
]
},
{
"username": "another-username",
"password": "",
"mysql_host": "mysql8",
"server_id": "1",
"client_id": "1",
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:52:32",
"server_name": "ch-servername",
"server_label": "Server Label",
"grants": [
{
"db_name": "db2",
"username": "another-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"
}
]
}
]
},
"msg": "Successful",
"status": true
}
"return": {
"total_items": 2,
"current_items": 2,
"current_page": 1,
"total_pages": 1,
"data": [
{
"username": "username",
"password": "",
"mysql_host": "mysql8",
"server_id": "1",
"client_id": "1",
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:48:48",
"server_name": "ch-servername",
"server_label": "Server Label",
"grants": [
{
"db_name": "db1",
"username": "username",
"host": "%",
"mysql_host": "mysql8",
"grants": [
"create view",
"select"
],
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:48:48"
}
]
},
{
"username": "another-username",
"password": "",
"mysql_host": "mysql8",
"server_id": "1",
"client_id": "1",
"pending": null,
"is_missing": "0",
"date_added": "0000-00-00 00:00:00",
"date_updated": "2020-10-21 15:52:32",
"server_name": "ch-servername",
"server_label": "Server Label",
"grants": [
{
"db_name": "db2",
"username": "another-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"
}
]
}
]
},
"msg": "Successful",
"status": true
}