Get Backup Status

Get Backup Status
Get backup status

Returns one backup job by id (from POST /backup or GET /backup/status).

Request
URI
GET
https://{api_host}/ssp/backup/status/{id}
COPY
Path Parameters
string
id
Required

Backup job id returned by POST /backup or listed in history.

id example
abcde
Authentication
This operation uses the following authentication methods.
Responses
200

Successful response

Returns BackupStatus of type(s) application/json
This response body class contains all of the following: Resource , InlineBackupStatus1 
{
    "_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"
    ],
    "backup_start_time": 0,
    "backup_end_time": 0,
    "progress": 0,
    "progress_message": "string",
    "backup_type": "string",
    "backup_trigger_type": "string",
    "status": "string",
    "file_size": 0,
    "version": "string",
    "error_messages": [
        "string"
    ],
    "no_of_entities": 0,
    "entities_status": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "status": "string",
            "error_messages": [
                "string"
            ]
        }
    ]
}

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.


404

Backup not found for provided id

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.


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 -H 'Authorization: <value>' https://{api_host}/ssp/backup/status/{id}
On This Page
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