Skip to main content

Retrieve volume-level restore status

Contributors

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/restore/status

Retrieves the status of the restore operation. This API endpoint tracks the restore job and retrieves the job status, error, time, and details of the restore job.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

accountId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

job

array[job]

False
Example response 
{
  "job": [
    {
      "id": "string",
      "status": "string",
      "error": "string",
      "data": {
        "restore": {
          "type": "string",
          "source": {
            "working-environment-id": "string",
            "working-environment-name": "string",
            "bucket": "string",
            "volume-id": "string",
            "volume-name": "string",
            "snapshot": "string"
          },
          "target": {
            "working-environment-id": "string",
            "working-environment-name": "string",
            "svm": "string",
            "volume-name": "string",
            "path": "string"
          },
          "file": [
            {
              "path": "string",
              "type": "string"
            }
          ]
        }
      }
    }
  ]
}

Definitions

See Definitions

source

Name Type Required Description

working-environment-id

string

False

working-environment-name

string

False

bucket

string

False

volume-id

string

False

volume-name

string

False

snapshot

string

False

target

Name Type Required Description

working-environment-id

string

False

working-environment-name

string

False

svm

string

False

volume-name

string

False

volume-size

number

False

path

string

False

file

Name Type Required Description

inode

number

False

path

string

False

type

string

False

size

number

False

mtime

number

False

restore

Name Type Required Description

type

string

False

source

source

False

target

target

False

file

array[file]

False

data

Name Type Required Description

restore

restore

False

job

Name Type Required Description

id

string

False

status

string

False

error

string

False

time

number

False

data

data

False