SiteHost API: /cloud/image/list

/cloud /image /list_all

GET https://api.sitehost.nz/1.0/cloud/image/list_all.json

Returns a list of all custom images for the client.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the custom images belong to.Example: 1
filters[code]	string		Show only custom images with a code that matches the specified string.Example: my-custom-image
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.0/cloud/image/list_all.json?apikey=your_key_here&client_id=1&filters[code]=my-custom-image", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.0/cloud/image/list_all.json?apikey=your_key_here&client_id=1&filters[code]=my-custom-image");
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.0/cloud/image/list_all.json?apikey=your_key_here&client_id=1&filters[code]=my-custom-image")
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.0/cloud/image/list_all.json?apikey=your_key_here&client_id=1&filters[code]=my-custom-image'

response = requests.get(uri)

Response

200:

application/json

{
    "return": {
        "total_items": 1,
        "current_items": 1,
        "current_page": 1,
        "total_pages": 1,
        "data": [
            {
                "id": "491",
                "client_id": "1",
                "label": "My Custom Image",
                "code": "my-custom-image",
                "version": "",
                "labels": "",
                "changelog": "",
                "date_added": "2017-02-09 15:29:13",
                "date_updated": "2017-02-09 02:29:21",
                "is_public": "0",
                "is_missing": "0",
                "project_id": "567",
                "registry_id": "7",
                "forked_from": null,
                "pending": null,
                "client_name": "My SiteHost Account",
                "image_type": "Custom",
                "registry_url": "registry-clients.sitehost.co.nz",
                "container_count": 0
            }
        ]
    },
    "msg": "Successful",
    "status": true
}