Create a new PostgreSQL Configuration

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property	Type	Description
`configuration_name`	string	new configuration name
`license`	string	license key
`password`	string(password)	PostgreSQL user password for Authentication on primary host
`source_host`	string	host name of source cluster
`source_pgbin_dir`	string	PostgreSQL bin directory on standby host
`source_port`	integer	PostgreSQL port number of source cluster (non-negative)
`standby_host`	string	host name for standby cluster
`standby_pgbin_dir`	string	PostgreSQL bin directory on standby host
`standby_port`	integer	PostgreSQL port number for standby cluster (non-negative)
`username`	string	PostgreSQL user name for Authentication on primary host

{
    "params": {
        "configuration_name": "string",
        "license": "string",
        "password": "string",
        "source_host": "string",
        "source_pgbin_dir": "string",
        "source_port": 123,
        "standby_host": "string",
        "standby_pgbin_dir": "string",
        "standby_port": 123,
        "username": "string"
    }
}

Response

HTTP Status: 200

Content Type: application/json

Response

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

configuration

Property	Type	Description
`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

error_response

Property	Type	Description
`message`	string	error message

auto_update_config

Property	Type	Description
`enabled`	boolean	whether automated standby updated is enabled
`interval_seconds`	integer	the configured automated standby update interval in seconds

database_info

Property	Type	Description
`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

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

update_delay_config

Property	Type	Description
`delay_minutes`	integer	number of minutes to keep standby behind primary; 0 to disable

{
    "error": {
        "message": "string"
    },
    "result": {
        "auto_update": {
            "enabled": false,
            "interval_seconds": 123
        },
        "configuration_id": 1,
        "configuration_name": "string",
        "configuration_type": "pgsql",
        "observer": {
            "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
        },
        "primary": {
            "host": "string",
            "port": 123,
            "state": "string"
        },
        "replication_mode": "not available",
        "standby": {
            "host": "string",
            "port": 123,
            "state": "string"
        },
        "time_gap_formatted": "string",
        "time_gap_seconds": 123,
        "update_delay": {
            "delay_minutes": 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!

/new/postgresql

Request

Parameters

Response

HTTP Status: 200

Response

HTTP Status: 400

Response

Comments