Zerto APIs : ZSSP Sessions API : View Existing Sessions
  
View Existing Sessions
Retrieve a list of existing session URLs. There are two options to retrieve session URLs:
■ Retrieve information about all existing ZSSP sessions.
■ Retrieve information about a specific ZSSP session.
The response to both options is the same.
Retrieve information about all existing ZSSP sessions
 
method
url
GET
https://zvm_ip:port/v1/zsspSessions
 
Where:
 
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
 
Request Body Using Json Format
The request Json body is empty.
Retrieve information about a specific ZSSP session
 
method
url
GET
https://zvm_ip:port/v1/zsspSessions/{zsspSessionIdentifier}
 
Where:
 
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
zsspSessionIdentifier
The identifier of the ZSSP session.
 
Request Body Using Json Format
The request Json body is empty.
Response In Json Format
The following is an example of a Json response body for https://zvm_ip:port/v1/zsspSessions and, without the array statement, for https://zvm_ip:port/v1/zsspSessions/{zsspSessionIdentifier}
 
[{
  "CreationTime": "2018-04-03T11:56:20.414Z",
  "LogoutRedirectUrl": "https://131.1.2.3:9672/zcm",
  "Url":   "https:///131.1.2.3:9779/ZvmService/GUI/Index.html#/?type=Portal&locale=en_US&sessionId=K6AKCA6UEHA5A7CDSZAJBUCGH2V6LNXMB3DQ5CPWK83S8SAF84A",
  "ZorgIdentifier": "e67ece8c-9365-4443-8b6b-90946df636b9",
  "ZorgUserName": "johndoe",
  "ZsspAddress": "https://131.1.2.3:9779",
  "ZsspSessionIdentifier": "K6AKCNA6UEHA5A7CDSZAJBUCGH2V6LNXMB3DQ5CPWK83S8SAF84A"
}]
 
Parameter
description
CreationTime
The time the session was created.
The creation time is according to the Zerto Virtual Manager clock where the API is run.
The time is in the format yyyy-mm-ddThh:mm:ss.fff, set to UTC.
LogoutRedirectUrl
The URL the customer is redirected to after logging out of the ZSSP or if the user is inactive for more than 10 minutes.
The URL can be used to redirect the user to the CSP’s portal.
If the logoutRedirectUrl is not specified in the request body when creating a ZSSP session, the response is null.
Url
The URL generated when creating a ZSSP session.
ZorgIdentifier
The identifier of the ZORG.
ZorgUserName
The username of the ZORG. If the zorgUserName is not specified in the request body, the response is null.
ZsspAddress
The address of the URL which the customer uses for browsing to access the ZSSP site.
ZsspSessionIdentifier
The identifier of the ZSSP session.
Back to ZSSP Sessions API
Back to All APIs