Start Restore

• Backup Restore

Start restore

Starts restore from backup_id; poll GET /restore/status/{id} using the id from the 202 response.

Request

URI

POST

https://{api_host}/ssp/restore

COPY

Request Body

Request to start restore

RestoreRequest of type(s) application/json

Required

Show optional properties

{
    "backup_id": "string",
    "action": "string"
}

{
    "backup_id": "bak-001",
    "action": "RESTORE"
}

string

id

Optional

Unique id of restore

string

name

Optional

Constraints: maxLength: 255

Backup name

string

description

Optional

Constraints: maxLength: 255

Backup description

string

backup_id

Required

Unique id of successful backup

boolean

force_restore

Optional

Bypasses validation pre-checks during the restore operation. If true, the system ignores recoverable errors that would otherwise block the restore

string

action

Required

Type of restore action for how to take restore

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

202

Hide Details

Successful response

Returns AsyncApiResponse of type(s) application/json

{
    "id": "b8f47985-22ed-3193-bca8-11c7b025cbce",
    "status_url": "/segmentation/default-ids-profiles/b8f47985-22ed-3193-bca8-11c7b025cbce/status"
}

string

id

Optional

UUID identifier of the response.

string

status_url

Optional

The URL to check the status of the operation.

400

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"backup_id":"string","action":"string"}' https://{api_host}/ssp/restore
                

On This Page

Description

Request

Request Body

Authentication

Response

202 Response Body

Errors

Backup Restore Operations

GET

Get Backup Config

PUT

Update Backup Config

GET

Get Recurring Backup Config

PUT

Update Recurring Backup Config

POST

Start Backup

GET

Get Backup Status

GET

Get Backup Status History

POST

Start Restore

GET

Get Restore Status

GET

Get Restore Status History