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

Update cluster configuration backup information

Contributors
PDFs

PATCH /support/configuration-backup

Updates the cluster configuration backup information.

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

password

string

url

string

An external backup location for the cluster configuration. This is mostly required for single node clusters where node and cluster configuration backups cannot be copied to other nodes in the cluster.

username

string

validate_certificate

boolean

Use this parameter with the value "true" to validate the digital certificate of the remote server. Digital certificate validation is available only when the HTTPS protocol is used in the URL; it is disabled by default.
Example request 
{
  "password": "yourpassword",
  "url": "http://10.224.65.198/backups",
  "username": "me"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

39387137

Invalid URL

39387138

Invalid URL Scheme

5963792

Using HTTPS for URL requires an effective cluster version of 9.7.0 or later.

5963794

Validating the certificate is supported for the HTTPS protocol only.
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

configuration_backup

Name Type Description

password

string

url

string

An external backup location for the cluster configuration. This is mostly required for single node clusters where node and cluster configuration backups cannot be copied to other nodes in the cluster.

username

string

validate_certificate

boolean

Use this parameter with the value "true" to validate the digital certificate of the remote server. Digital certificate validation is available only when the HTTPS protocol is used in the URL; it is disabled by default.

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.