List General Settings
Service name: list_general_settings
Base URL
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_general_settings
Description
Lists general settings for the account.
Parameters
Optional parameters
Add optional parameters after the required parameters in the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_general_settings&optional_parameters={parameter-value}
Parameter | Description | Type | Options | Default |
---|---|---|---|---|
describe | Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions. | boolean | true | 0 |
Examples
List general settings
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_general_settings
Example response
<?xml version="1.0"?>
<settings created="2010-09-16T08:53:03+01:00" host="SERVERi">
<items>
<general>
<language>en_GB</language>
<clear24x7checks>1</clear24x7checks>
<cleardailysafetychecks>1</cleardailysafetycheck>
<notesbacklog>90</notesbacklog>
<forcenotes>0</forcenotes>
<vartimezone>Europe/London</vartimezone>
</general>
</items>
</settings>
Returned fields
Field | Type | Can Be Empty | Description |
---|---|---|---|
language | string | no | Language representation |
clear24x7checks | integer | no | 1 or 0 flag |
cleardailysafetychecks | integer | no | 1 or 0 flag |
notesbacklog | integer | no | Number of days |
forcenotes | integer | no | 1 or 0 flag |
vartimezone | string | yes | Account time zone |
Updated about 1 month ago