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

(POST) /backupServers/{ID}/credentials?action=create

On This Page

Request
Response
Example

Creates new credentials on the Veeam backup server having the specified ID.

Request

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

HTTP Request

POST http://<Enterprise-Manager>:9399/api/backupServers/{ID}/credentials?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. To learn more, see Authentication and Security.

Request Body

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

The request body must contain the following elements:

Element	Type	Description	Modifiable	Min/Max Occurrence
Username	String	User name of the added credentials record in the DOMAIN\USENAME format.	Yes	0/1
Description	String	Description of the added credentials record.	Yes	0/1
Password	String	Password of the added credentials.	Yes	0/1

For example:

<?xml version="1.0" encoding="utf-8"?>
<CredentialsInfoSpec 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">
<Username>VEEAM\Administrator</Username>
<Description>Created via RESTful API</Description>
<Password>1234</Password>
</CredentialsInfoSpec>

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully operation returns response code 201 Created.

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: application/xml.

Response Body

None.

Example

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

User name VEEAM\Administrator
Password 1234
Description Credentials created via RESTful API

Request:

POST http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/credentials?action=create

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<CredentialsInfoSpec 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">
<Username>VEEAM\Administrator</Username>
<Description>Credentials created via RESTful API</Description>
<Password>1234</Password>
</CredentialsInfoSpec>

Response:

201 Created

Response Body:

None