Skip to main content
A newer release of this product is available.

Retrieve configuration backup files

Contributors
PDFs

GET /support/configuration-backup/backups

Introduced In: 9.7

Retrieves a list of configuration backup files.

  • system configuration backup show

Parameters

Name Type In Required Description

auto

boolean

query

False

Filter by auto

type

string

query

False

Filter by type

size

integer

query

False

Filter by size

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

name

string

query

False

Filter by name

backup_nodes.name

string

query

False

Filter by backup_nodes.name

version

string

query

False

Filter by version

download_link

string

query

False

Filter by download_link

time

string

query

False

Filter by time

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[configuration_backup_file]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "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-04T13:33:48-05:00",
      "type": "string",
      "version": "9.7.0"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

backup_node

The node name in the backup.

Name Type Description

name

string

_links

Name Type Description

self

href

node

The node that owns the configuration backup.

Name Type Description

_links

_links

name

string

uuid

string

configuration_backup_file

The configuration backup file.

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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.