SiteHost API: /redirect/list

/redirect /list_redirects

GET https://api.sitehost.nz/1.1/redirect/list_redirects.json

Get a list of redirects that have been setup with their origin, desitnation and type.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the IP addresses belong to.Example: 1
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.1/redirect/list_redirects.json?apikey=your_key_here&client_id=1", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/redirect/list_redirects.json?apikey=your_key_here&client_id=1");
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/redirect/list_redirects.json?apikey=your_key_here&client_id=1")
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/redirect/list_redirects.json?apikey=your_key_here&client_id=1'

response = requests.get(uri)

Response

200:

application/json

{
  "return": {
    "example.kiwi.nz": {
      "a.example.kiwi.nz": {
        "destination": "https://movedpermanently.com",
        "type": 301
      },
      "b.example.kiwi.nz/blog/category": {
        "destination": "https://movedtemporarily.com",
        "type": 302
      }
    }
  },
  "msg": "Successful",
  "status": true
}