SiteHost API: /server/firewall/security_groups/list

/server /firewall /security_groups /list_all

GET https://api.sitehost.nz/1.5/server/firewall/security_groups/list_all.json

List all of your Security Groups.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client.Example: 1
filters[label]	string		Only show Security Groups with labels which match the specified string.Example: My Security Group
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.5/server/firewall/security_groups/list_all.json?apikey=your_key_here&client_id=1&filters[label]=My+Security+Group", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.5/server/firewall/security_groups/list_all.json?apikey=your_key_here&client_id=1&filters[label]=My+Security+Group");
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.5/server/firewall/security_groups/list_all.json?apikey=your_key_here&client_id=1&filters[label]=My+Security+Group")
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.5/server/firewall/security_groups/list_all.json?apikey=your_key_here&client_id=1&filters[label]=My+Security+Group'

response = requests.get(uri)

Response

200:

application/json

{
  "return": {
    "total_items": 5,
    "current_items": 5,
    "current_page": 1,
    "total_pages": 1,
    "data": [
      {
        "name": "sgfc40e62092",
        "label": "My Security Group",
        "version": 18,
        "servers": [],
        "date_updated": "2024-12-02 22:55:07",
        "pending": null,
        "is_missing": false
      },
      {
        "name": "sgfc40e62093",
        "label": "My Other Security Group",
        "version": 3,
        "servers": [],
        "date_updated": "2024-10-31 23:16:40",
        "pending": null,
        "is_missing": false
      }
    ]
  },
  "msg": "Successful",
  "status": true
}