POST /backupServers/{ID}/passwords?action=create

In this article

    Creates a new password on the backup server having the specified ID.

    Request

    To create a new password record on a specific backup server, send the POST HTTP request to the /backupServers/{ID}/passwords?action=create URL.

    HTTP Request

    POST https://<Enterprise-Manager>:9398/api/backupServers/{ID}/passwords?action=create

    Request Headers

    The request contains the following headers:

    Header

    Required

    Description

    X-RestSvcSessionId

    True

    The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

    Content-Type

    True

    Identifies the format of the request body message. Possible values:

    • application/xml
    • application/json

    Accept

    False

    Identifies the format of the response. Possible values:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    In the request body, the client must send parameters for a new password that must be created on the backup server. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager REST API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    Hint

    String

    Hint for the created password.

    Yes

    0/1

    Password

    String

    Password value.

    Yes

    1/1

    For example:

    XML Representation

    <?xml version="1.0" encoding="utf-8"?>
    <PasswordKeyInfoSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <Hint>My favorite book</Hint>
     <Password>1234</Password>
    </PasswordKeyInfoSpec>

    JSON Representation

    {

     "Hint": "My favorite book",

     "Password": "1234"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully operation returns response code 202 (ACCEPTED).

    Response Headers

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

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message. Possible values:

    • application/xml
    • application/json

    Response Body

    None.

    Example

    The example below adds a new password on the backup server having ID f62624c1-8462-4747-8bd4-d686f99b0540. The password record has the following parameters:

    • Hint: My favorite book
    • Password: 1234

    Request:

    POST https://localhost:9398/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/passwords?action=create

     

    Request Headers:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
    Content-Type         application/xml

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <PasswordKeyInfoSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <Hint>My favorite book</Hint>
     <Password>1234</Password>
    </PasswordKeyInfoSpec>

     

    Response:

    201 Created

     

    Response Body:

    None