Get Restore Status

Get Restore Status

Get currently running or last Restore job status

Request
URI
GET
https://{api_host}/api/ni/config/restore/status
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BackupRestoreStatusResponse of type(s) application/json
{
    "status": "IN_PROGRESS",
    "backup_file_name": "vrni_backup-10000-2020-12-15-13-00-40.tar",
    "status_updated_timestamp": "vrni_backup-10000-2020-12-15-13-00-40.tar",
    "failed_components": [
        "string"
    ]
}
string
status
Optional

Status of currently executing or last backup-restore job

string
backup_file_name
Optional

File name of backup tar file

string
status_updated_timestamp
Optional

TimeStamp of the last status update

array of string
failed_components
Optional

List of components failed to backup or restore


400

Bad Request

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


500

Internal Error

Operation doesn't return any data structure