Editing Passwords

This section explains how to edit an encryption password.

Request

PUT https://<hostname>:4443/v5/EncryptionKeys/{recordId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request.

Parameter

Type

Description

recordId

string

A credentials record identification number.

Request Body

Property

Type

Description

oldpassword

string

Specifies current encryption password.

newpassword

string

Specifies a new encryption password.

description

string

Specifies the hint of the encryption password.

Request Example

Request:

PUT https://abc.tech.local:4443/v5/EncryptionKeys/af51ba2b-835e-4d95-a115-cd05d069f856

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "oldpassword": "123qweASD",

  "newpassword": "123QWEASD",

  "description": "Developer"

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.