Remove READ ONLY mode schedule

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property	Type	Description	Required
`configuration_id`	integer(int64)	configuration ID (non-negative)	required
`schedule_id`	string	READ ONLY mode schedule ID to remove	required

{
    "params": {
        "configuration_id": 1,
        "schedule_id": "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 `read_only_mode_enable_schedule_function_sqlserver_response`	read-only-mode/enable-schedule-function/sqlserver response
`successful`	boolean	response with error or not

error_response

Property	Type	Description
`message`	string	error message

read_only_mode_enable_schedule_function_sqlserver_response

Property	Type	Description
`enabled`	boolean	whether the scheduled READ ONLY mode feature is enabled
`schedules`	array of read_only_mode_schedule	list of READ ONLY mode schedules
`standby_file_directory`	string	directory in which to create standby file

read_only_mode_schedule

Property	Type	Description
`cron_expression`	string	cron expression specifying when to activate READ ONLY mode
`duration_in_minutes`	integer	duration of READ ONLY mode, in minutes
`is_active`	boolean	whether the schedule is active
`schedule_id`	string	READ ONLY mode schedule ID
`schedule_name`	string	name of schedule

{
    "error": {
        "message": "string"
    },
    "result": {
        "enabled": false,
        "schedules": [
            {
                "cron_expression": "string",
                "duration_in_minutes": 123,
                "is_active": false,
                "schedule_id": "string",
                "schedule_name": "string"
            }
        ],
        "standby_file_directory": "string"
    },
    "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!

/read-only-mode/remove-schedule/sqlserver

Request

Parameters

Response

HTTP Status: 200

Response

HTTP Status: 400

Response

Comments