Skip to main content

Retrieve configuration backup file details

Contributors
PDFs

GET /support/configuration-backup/backups/{node.uuid}/{name}

Introduced In: 9.7

Retrieves details of the specified configuration backup file.

  • system configuration backup show

Parameters

Name Type In Required Description

node.uuid

string

path

True

UUID of the node that owns the configuration backup.

name

string

path

True

Name of the configuration backup.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

auto

boolean

Indicates if the backup was created automatically.

backup_nodes

array[backup_node]

The list of nodes included in the backup.

download_link

string

The link to download the backup file.

name

string

The backup name.

node

node

The node that owns the configuration backup.

size

integer

The size of the backup in bytes.

time

string

The backup creation time.

type

string

The backup type.

version

string

The software version.
Example response 
{
  "backup_nodes": [
    {
      "name": "string"
    }
  ],
  "download_link": "https://10.224.65.198/backups/backup_file.7z",
  "name": "backup_file.7z",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "size": 4787563,
  "time": "2019-02-04 13:33:48 -0500",
  "type": "string",
  "version": "9.7.0"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5963777

Configuration backup file does not exist.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

backup_node

The node name in the backup.

Name Type Description

name

string

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

The node that owns the configuration backup.

Name Type Description

_links

_links

name

string

uuid

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.