/cloud/image/version/list_all
GET https://api.sitehost.nz/1.1/cloud/image/version/list_all.json
Returns a list of custom image versions.
Query Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the custom images belong to.Example: 1 |
image_id | integer | Yes | The ID for the custom image to list versions for.Example: 77 |
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.1/cloud/image/version/list_all.json?apikey=your_key_here&client_id=1&image_id=77", false);
xmlHttp.send();
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/cloud/image/version/list_all.json?apikey=your_key_here&client_id=1&image_id=77");
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/image/version/list_all.json?apikey=your_key_here&client_id=1&image_id=77")
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/image/version/list_all.json?apikey=your_key_here&client_id=1&image_id=77'
response = requests.get(uri)
Response
200:application/json
{
"return": {
"total_items": 1,
"current_items": 1,
"current_page": 1,
"total_pages": 1,
"data": [
{
"id": "6421",
"client_id": "1",
"image_id": "415",
"version": "1.1-1076",
"labels": "<image labels here>",
"date_added": "2016-10-21 09:41:10",
"date_updated": "2017-02-09 16:17:01",
"is_missing": "0",
"force_config": "0",
"build_id": "1076",
"build_status": "success",
"pending": null,
"code": "my-custom-image",
"container_count": 0
}
]
},
"msg": "Successful",
"status": true
}
"return": {
"total_items": 1,
"current_items": 1,
"current_page": 1,
"total_pages": 1,
"data": [
{
"id": "6421",
"client_id": "1",
"image_id": "415",
"version": "1.1-1076",
"labels": "<image labels here>",
"date_added": "2016-10-21 09:41:10",
"date_updated": "2017-02-09 16:17:01",
"is_missing": "0",
"force_config": "0",
"build_id": "1076",
"build_status": "success",
"pending": null,
"code": "my-custom-image",
"container_count": 0
}
]
},
"msg": "Successful",
"status": true
}