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

(POST) /sessionMngr/

Creates a new logon session for Veeam Backup Enterprise Manager RESTful API.

Request

To create a new logon session, you need to send the POST HTTP request to the URL of the /sessionMngr/ resource.

(POST) /sessionMngr/ Note:

To work with Veeam Backup Enterprise Manager RESTful API resources available in the current version of Veeam Backup & Replication and to access a complete set of actions that can be performed with those resources, create a new logon session using the link to the latest version of the /sessionMngr/ resource. To learn more, see Perform Logon.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/sessionMngr/?v=v1_3

or

POST http://<Enterprise-Manager>:9399/api/sessionMngr/?v=latest

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.

(POST) /sessionMngr/ Note:

To create a new logon session for a tenant, you need to provide tenant credentials in the request body. To learn more, see Tenant Logon Session.

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed 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

In the response body, Veeam Backup Enterprise Manager returns a resource representation of the created logon session. The resource representation of the logon session contains links to resources available through Veeam Backup Enterprise Manager RESTful API.

Example

The example below creates a new logon session for Veeam Backup Enterprise Manager RESTful API.

Request:

POST http://localhost:9399/api/sessionMngr/?v=v1_3

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

None

 

Response:

201 Created

 

Response Body:

<LogonSession xmlns="http://www.veeam.com/ent/v1.0" Type="LogonSession" Href="http://localhost:9399/api/logonSessions/5496707f-c814-47ce-8d6d-110aa03cec03">
 <Links>
   <Link Rel="Up" Type="EnterpriseManager" Href="http://localhost:9399/api/" />
   <Link Rel="Down" Type="BackupServerReferenceList" Href="http://localhost:9399/api/backupServers" />
   <Link Rel="Down" Type="ManagedServerReferenceList" Href="http://localhost:9399/api/managedServers" />
   <Link Rel="Down" Type="JobReferenceList" Href="http://localhost:9399/api/jobs" />
   <Link Rel="Down" Type="FailoverPlanReferenceList" Href="http://localhost:9399/api/failoverPlans" />
   <Link Rel="Down" Type="HierarchyRootReferenceList" Href="http://localhost:9399/api/hierarchyRoots" />
   <Link Rel="Down" Type="RepositoryReferenceList" Href="http://localhost:9399/api/repositories" />
   <Link Rel="Down" Type="BackupReferenceList" Href="http://localhost:9399/api/backups" />
   <Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/restorePoints" />
   <Link Rel="Down" Type="VmRestorePointReferenceList" Href="http://localhost:9399/api/vmRestorePoints" />
   <Link Rel="Down" Type="VAppRestorePointReferenceList" Href="http://localhost:9399/api/vAppRestorePoints" />
   <Link Rel="Down" Type="ReplicaReferenceList" Href="http://localhost:9399/api/replicas" />
   <Link Rel="Down" Type="VmReplicaPointReferenceList" Href="http://localhost:9399/api/vmReplicaPoints" />
   <Link Rel="Down" Type="CatalogVmReferenceList" Href="http://localhost:9399/api/catalog/vms" />
   <Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/backupSessions" />
   <Link Rel="Down" Type="RestoreSessionReferenceList" Href="http://localhost:9399/api/restoreSessions" />
   <Link Rel="Down" Type="ReplicaJobSessionReferenceList" Href="http://localhost:9399/api/replicaSessions" />
   <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="http://localhost:9399/api/backupTaskSessions" />
   <Link Rel="Down" Type="ReplicaTaskSessionReferenceList" Href="http://localhost:9399/api/replicaTaskSessions" />
   <Link Rel="Down" Type="EnterpriseSecuritySettings" Href="http://localhost:9399/api/security" />
   <Link Rel="Down" Type="WanAcceleratorReferenceList" Href="http://localhost:9399/api/wanAccelerators" />
   <Link Rel="Down" Type="BackupFileReferenceList" Href="http://localhost:9399/api/backupFiles" />
   <Link Rel="Down" Type="TaskList" Href="http://localhost:9399/api/tasks" />
   <Link Rel="Down" Type="QueryService" Href="http://localhost:9399/api/querySvc" />
   <Link Rel="Down" Type="LookupService" Href="http://localhost:9399/api/lookupSvc" />
   <Link Rel="Down" Type="Report" Href="http://localhost:9399/api/reports/summary" Name="Summary" />
   <Link Rel="Down" Type="BackupServerList" Href="http://localhost:9399/api/backupServers?format=Entity" />
   <Link Rel="Down" Type="ManagedServerList" Href="http://localhost:9399/api/managedServers?format=Entity" />
   <Link Rel="Create" Href="http://localhost:9399/api/backupServers?action=create" />
   <Link Rel="Down" Type="JobList" Href="http://localhost:9399/api/jobs?format=Entity" />
   <Link Rel="Down" Type="FailoverPlanList" Href="http://localhost:9399/api/failoverPlans?format=Entity" />
   <Link Rel="Down" Type="HierarchyRootList" Href="http://localhost:9399/api/hierarchyRoots?format=Entity" />
   <Link Rel="Down" Type="RepositoryList" Href="http://localhost:9399/api/repositories?format=Entity" />
   <Link Rel="Down" Type="BackupList" Href="http://localhost:9399/api/backups?format=Entity" />
   <Link Rel="Down" Type="RestorePointList" Href="http://localhost:9399/api/restorePoints?format=Entity" />
   <Link Rel="Down" Type="VmRestorePointList" Href="http://localhost:9399/api/vmRestorePoints?format=Entity" />
   <Link Rel="Down" Type="VAppRestorePointList" Href="http://localhost:9399/api/vAppRestorePoints?format=Entity" />
   <Link Rel="Down" Type="ReplicaList" Href="http://localhost:9399/api/replicas?format=Entity" />
   <Link Rel="Down" Type="VmReplicaPointList" Href="http://localhost:9399/api/vmReplicaPoints?format=Entity" />
   <Link Rel="Down" Type="CatalogVmList" Href="http://localhost:9399/api/catalog/vms?format=Entity" />
   <Link Rel="Down" Type="BackupJobSessionList" Href="http://localhost:9399/api/backupSessions?format=Entity" />
   <Link Rel="Down" Type="RestoreSessionList" Href="http://localhost:9399/api/restoreSessions?format=Entity" />
   <Link Rel="Down" Type="ReplicaJobSessionList" Href="http://localhost:9399/api/replicaSessions?format=Entity" />
   <Link Rel="Down" Type="BackupTaskSessionList" Href="http://localhost:9399/api/backupTaskSessions?format=Entity" />
   <Link Rel="Down" Type="ReplicaTaskSessionList" Href="http://localhost:9399/api/replicaTaskSessions?format=Entity" />
   <Link Rel="Down" Type="WanAcceleratorList" Href="http://localhost:9399/api/wanAccelerators?format=Entity" />
   <Link Rel="Down" Type="VCloudService" Href="http://localhost:9399/api/vCloud" />
   <Link Rel="Down" Type="BackupFileList" Href="http://localhost:9399/api/backupFiles?format=Entity" />
   <Link Rel="Down" Type="CloudConnectService" Href="http://localhost:9399/api/cloud" />
   <Link Rel="Delete" Href="http://localhost:9399/api/logonSessions/5496707f-c814-47ce-8d6d-110aa03cec03" />
 </Links>
 <UserName>SRV13\Administrator</UserName>
 <SessionId>5496707f-c814-47ce-8d6d-110aa03cec03</SessionId>
</LogonSession>

 

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation