Show observer settings

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property	Type	Description	Required
`configuration_id`	integer(int64)	configuration ID (non-negative)	required

{
    "params": {
        "configuration_id": 1
    }
}

Response

HTTP Status: 200

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`result`	object of type `observer_config`	observer configuration
`successful`	boolean	response with error or not

error_response

Property	Type	Description
`message`	string	error message

observer_config

Property	Type	Description
`check_interval_seconds`	integer	the configured observer check interval in seconds
`custom_script_primary`	string	full path of the custom script to use on the primary host
`custom_script_rule`	string	whether and how to use custom scripts to affect the Observer's behavior' (possible values: 'disabled', 'custom-only', 'either' and 'both')
`custom_script_standby`	string	full path of the custom script to use on the standby host
`emergency_action`	string	action to take once the maximum number of failures has been reached (possible values: 'activate' and 'notify')
`enabled`	boolean	whether the observer is enabled
`heartbeat_enabled`	boolean	whether to send a daily notification to confirm the observer is running; you need to have send_email or send_slack enabled for this to work
`heartbeat_hour`	integer	the hour of the day in the Control Center timezone at which to send the heartbeat notification (0-23)
`heartbeat_minute`	integer	the minute of the hour at which to send the heartbeat notification (0-59)
`max_fail_count`	integer	once this number of failures has been reached, the emergency action is taken and the observer is disabled
`send_email`	boolean	whether to send notifications to the email addresses configured for notifications on the configuration
`send_slack`	boolean	whether to send notifications to the Slack webhooks configured for notifications on the configuration
`time_gap_check_enabled`	boolean	whether to send a notification if the time gap exceeds the configured threshold
`time_gap_check_threshold_seconds`	integer	maximum number of seconds for the time gap check

{
    "error": {
        "message": "string"
    },
    "result": {
        "check_interval_seconds": 123,
        "custom_script_primary": "string",
        "custom_script_rule": "disabled",
        "custom_script_standby": "string",
        "emergency_action": "activate",
        "enabled": false,
        "heartbeat_enabled": false,
        "heartbeat_hour": 123,
        "heartbeat_minute": 123,
        "max_fail_count": 123,
        "send_email": false,
        "send_slack": false,
        "time_gap_check_enabled": false,
        "time_gap_check_threshold_seconds": 123
    },
    "successful": true
}

HTTP Status: 400

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`successful`	boolean	always false

error_response

Property	Type	Description
`message`	string	error message

{
    "error": {
        "message": "string"
    },
    "successful": false
}

We're here to help!

/observer/show/sqlserver

Request

Parameters

Response

HTTP Status: 200

Response

HTTP Status: 400

Response

Comments