Set Export Settings

Set Export Settings

Set the export settings. The export settings include enableScheduler, retention, scheduleSpec, and so on. If the 'enableScheduler' is set 'True' and 'ScheduleSpec' was set before or is set in the same time, a cron job which exports config on schedule will be created. If the 'enableScheduler' is not set, 'ScheduleSpec' is set and "enableScheduler" is enabled before, the cron job is also created. If the 'enableScheduler' is set to 'False', the existed cron job will be deleted.

Request
URI
PATCH
https://{api_host}/server/configuration/backup/settings
COPY
Path Parameters
string
pairing_id
Required Deprecated

Deprecated. The ID of a pairing between this Site Recovery Manager server and remote one.

string
srm_id
Required Deprecated

Deprecated. ID of a Site Recovery Manager server.

Request Body

The specification of export operation.

ExportSettingsSpec of type(s) application/json
Required 
{
    "schedule": {
        "time": {
            "hh": 0,
            "mm": 0
        },
        "frequency": 0,
        "day_of_week": "string"
    },
    "enable_scheduler": false,
    "retention": 0,
    "datastore_path": {
        "datastore": "Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd",
        "path": "/path/to/folder"
    }
}
object
schedule
Optional

Describe the schedule of export operation.

boolean
enable_scheduler
Optional

Activate or deactivate export config on schedule. If this value is not set, the previously set value is used. If this is never configured, the default value is 'false'.

integer As int32 As int32
retention
Optional
Constraints: minimum: 1

How many export files should remain. If this value is not set, the previously set value is used. If this is never configured, the default value is '32'.

object
datastore_path
Optional

The location of a directory on a datastore.

Authentication
This operation uses the following authentication methods.
Responses
204

The export settings was successfully modified.

Operation doesn't return any data structure

400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Server Operations
POST
Export Configuration
POST
Upload Export Files
GET
Get Export Files Info
DELETE
Delete Export Files
GET
Retrieve Export File
GET
Get Export Settings
PATCH
Set Export Settings
GET
Get Info