Update Recurring Backup Config

Update recurring backup configuration

Saves scheduled backup policy; set weekly or interval fields to match backup_schedule_type.

Request

URI

PUT

https://{api_host}/ssp/backup/recurring/config

COPY

Request Body

Request to configure automated backups

RecurringBackupConfig of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineRecurringBackupConfig1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "enabled": false,
    "backup_type": "string",
    "backup_schedule_type": "string",
    "backup_schedule_weekly": {
        "days_of_week": [
            "string"
        ],
        "hour_of_day": 0,
        "minute_of_day": 0
    },
    "backup_schedule_interval": {
        "hours_between_backups": 0
    }
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

200

Successful response

Returns RecurringBackupConfig of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineRecurringBackupConfig1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "enabled": false,
    "backup_type": "string",
    "backup_schedule_type": "string",
    "backup_schedule_weekly": {
        "days_of_week": [
            "string"
        ],
        "hour_of_day": 0,
        "minute_of_day": 0
    },
    "backup_schedule_interval": {
        "hours_between_backups": 0
    }
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

Unexpected error occurred

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"enabled":"boolean","backup_type":"string","backup_schedule_type":"string"}' https://{api_host}/ssp/backup/recurring/config

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Backup Restore Operations

GET

Get Backup Config

PUT