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

Operations and Methods

The following method-implemented operations are supported for the /users collection in the Veeam Backup for AWS REST API:

(GET)/api/v1/users — retrieves resource representation of all Veeam Backup for AWS users.
(GET)/api/v1/users/{userId} — retrieves representation of a Veeam Backup for AWS user with the specified ID.
(POST)/api/v1/users — creates a new Veeam Backup for AWS user.
(PUT)/api/v1/users/{userId} — modifies user data of a Veeam Backup for AWS user with the specified ID.
(POST)/api/v1/users/validateName — checks whether a user name is unique and meets the Veeam Backup for AWS requirements.
(POST)/api/v1/users/validateDescription — checks whether a user description meets the Veeam Backup for AWS requirements.
(POST)/api/v1/users/validatePassword — checks whether a password meets the Veeam Backup for AWS requirements.
(DELETE)/api/v1/users/{userId} — deletes a Veeam Backup for AWS user with the specified ID.
(POST)/api/v1/users/export — exports a list of Veeam Backup for AWS users to a file.