/switchover/postgresql

Follow

Swap the roles of the primary and standby clusters

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property

Type

Description

Required

configuration_id

integer(int64)

configuration ID (non-negative)

required

user_script

string map

optional script or scripts to execute after switchover on primary or standby host (key must be primary or standby host; value must be an existing user script)

{
    "params": {
        "configuration_id": 1,
        "user_script": {
            "host1": "/usr/local/bin/script"
        }
    }
}

Response

HTTP Status: 200

Content Type: application/json

Response

Property

Type

Description

error

object of type error_response

error response

result

object of type task_response

successful

boolean

response with error or not

error_response

Property

Type

Description

message

string

error message

task_response

Property

Type

Description

task_id

integer(int64)

task ID

{
    "error": {
        "message": "string"
    },
    "result": {
        "task_id": 1
    },
    "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
}
Have more questions? Submit a request

Comments