This method will return all failover pools within the account for the specific IP type requested, including all sub-companies, if they exist.
The {options} allow you to refine the results retrieved from the API. They must be formatted as a query string, e.g. if you use more than one, the 2nd one onwards should be preceded by an ampersand “&” character. The options include:
| Parameters | Description |
|
perpage={value}
|
An integer for number of items you would like returned in this response. E.g. {20} |
| pageno={page} | An integer for the page number (only applicable if the perpage is used). E.g. {1} |
| sortField={value} | The field you wish to sort by. E.g. {Name}, {Method} etc. |
| sortOrder={value} | The sort direction. E.g. {asc} or {desc} |
| searchField={value} | The field you wish to search for. E.g. {Name} |
| searchString={value} | The value you wish to search for. E.G. in the case of the search field being {Name} this could be {web farm} (note, a url encode the search string, e.g. a space must be %20 ) |
| searchOper={value} | This is a 2 letter code to specify how to use the search string: bw = begins with cn = contains ew = ends with eq = equal to ne = not equal to |
Sample CURL for retrieving all IPv4 Failover Pools
curl -u username:password -X GET -H “Accept: application/json” “https://api.totaluptime.com/CloudDNS//Failover/Pool/IPv4/All”