Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(GET) /security/roles/{ID}

Returns a security role having the specified ID. The security role belongs to a list of roles used in Veeam Backup Enterprise Manager.

Veeam Backup Enterprise Manager REST API exposes the following security roles:

  • Portal User
  • Portal Administrator
  • VM Restore Operator
  • File Restore Operator
  • Exchange Restore Operator
  • SQL Restore Operator

Request

To get a security role used in Veeam Backup Enterprise Manager, you need to send the GET HTTP request to the URL of the /security/roles/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/security/roles/{ID}

Request Header

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

None.

Query Parameters

None.

 

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

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

In the response body, Veeam Backup Enterprise Manager returns a representation of the /security/roles/{ID} resource.

Example

A sample request below returns the Portal User security role in used Veeam Backup Enterprise Manager.

Request:

GET http://localhost:9399/api/security/roles/d19a3d33-cb77-4ffe-94e6-001432483a4e

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/d19a3d33-cb77-4ffe-94e6-001432483a4e" Name="Portal User" UID="urn:veeam:EnterpriseRole:d19a3d33-cb77-4ffe-94e6-001432483a4e">
 <Links>
   <Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/d19a3d33-cb77-4ffe-94e6-001432483a4e?format=Entity" />
 </Links>
</EntityRef>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation