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

Step 4. Perform Logout

To finish working with Veeam Backup Enterprise Manager RESTful API and log out:

  1. Send the GET HTTP request to the /logonSessions resource to get a list of existing logon sessions:

Request:

GET http://localhost:9399/api/logonSessions

 

Response:

200 Success

 

Response Body:

<LogonSessions xmlns="http://www.veeam.com/ent/v1.0">
 <LogonSession Type="LogonSession" Href="http://localhost:9399/api/logonSessions/695f7cda-e4a6-4d9c-9603-8a6b05693c57">
   <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="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="CloudConnectService" Href="http://localhost:9399/api/cloud" />
     <Link Rel="Delete" Type="LogonSession" Href="http://localhost:9399/api/logonSessions/695f7cda-e4a6-4d9c-9603-8a6b05693c57" />
   </Links>
   <UserName>SRV36\Administrator</UserName>
   <SessionId>695f7cda-e4a6-4d9c-9603-8a6b05693c57</SessionId>
 </LogonSession>
</LogonSessions>

  1. Examine the representation of the logon session and find a link to logon session deletion:

<Link Rel="Delete" Type="LogonSession" Href="http://localhost:9399/api/logonSessions/695f7cda-e4a6-4d9c-9603-8a6b05693c57"

  1. Send the DELETE HTTP request to the obtained link:

Request:

DELETE http://localhost:9399/api/logonSessions/695f7cda-e4a6-4d9c-9603-8a6b05693c57

 

Response:

204 Deleted

  1. If you are using Veeam Backup Enterprise Manager Web Client, close the browser window.

The logon session will be deleted.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.