add_source_instance

boolean

add new source instance

add_standby_instance

boolean

add new standby instance

license

string

license key

source_auth_type

string

authentication type, value should be either 'SQL' or 'WIN' (used when adding source instance) (possible values: 'SQL' and 'WIN')

source_db

string

name of source database

source_host

string

host name of instance containing source database

source_instance

string

name of instance containing source database

source_log_dir

string

log backup location on source host

source_password

string(password)

password for authentication to instance (used when adding source instance)

source_port

integer

port number of instance to add (used when adding source instance) (non-negative)

source_username

string

user name for authentication to instance (used when adding source instance)

standby_auth_type

string

authentication type, value should be either 'SQL' or 'WIN' (used when adding standby instance) (possible values: 'SQL' and 'WIN')

standby_host

string

host name of instance for standby database

standby_instance

string

name of instance for standby database

standby_log_dir

string

log backup location on standby host

standby_password

string(password)

password for authentication to instance (used when adding standby instance)

standby_port

integer

port number of instance to add (used when adding standby instance) (non-negative)

standby_username

string

user name for authentication to instance (used when adding standby instance)

error

object of type error_response

error response

result

object of type configuration

DR Configuration

successful

boolean

response with error or not

configuration_id

integer(int64)

configuration ID (non-negative)

configuration_name

string

configuration name

configuration_type

string

configuration type (possible values: 'oracle', 'pgsql' and 'mssql')

observer

object of type observer_config

observer configuration

auto_update

object of type auto_update_config

automated standby update configuration

primary

object of type database_info

information about the primary database or cluster

replication_mode

string

replication mode for PostgreSQL configurations, or empty for other configuration types (possible values: 'not available', 'ARCHIVING', 'LOGSHIPPING' and 'STREAMING')

standby

object of type database_info

information about the standby database or cluster

time_gap_formatted

string

time gap between primary and standby, formatted for display

time_gap_seconds

integer

number of seconds standby is behind primary, or null if not available

update_delay

object of type update_delay_config

standby update delay configuration

message

string

error message

enabled

boolean

whether automated standby updated is enabled

interval_seconds

integer

the configured automated standby update interval in seconds

host

string

host name of the database, instance or cluster

port

integer

cluster port for PostgreSQL configurations, instance port for SQL Server configurations, or omitted for Oracle configurations

state

string

database or cluster state, if requested, otherwise empty

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

delay_minutes

integer

number of minutes to keep standby behind primary; 0 to disable

error

object of type error_response

error response

successful

boolean

always false

message

string

error message