This is an archive version of the document. To get the most up-to-date information, see the current version.

Adding Passwords

In this article

    This section explains how to add a new password.

    Request

    POST https://<hostname>:4443/v4/EncryptionKeys

    Request Headers

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

    Request Body

    Property

    Type

    Description

    password

    string

    Specifies the ID of an encrypted password record.

    description

    string

    Specifies the hint of an encrypted password record.

    Request Example

    POST https://abc.tech.local:4443/v4/EncryptionKeys/

     

    Request Header:

    Authorization: Bearer <Access-Token>

    Request Body:

    {

      "password": "123qweASD",

      "description": "Developer 1"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 201 (Created).

    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

    Property

    Type

    Description

    id

    string

    Specifies the ID of an encrypted password record.

    description

    string

    Specifies the hint of an encrypted password record.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    Response:

    201 Created

     

    Response Body:

    {

      "id": "7827a047-33ac-4d20-a8d8-1cd283755044",

      "description": "Developer 1",

      "_links": {"self": {"href": "https://abc.tech.local:4443/v4/encryptionkeys/7827a047-33ac-4d20-a8d8-1cd283755044"}}

    }

    I want to report a typo

    There is a misspelling right here:

     

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