Zerto APIs : ZSSP Sessions API : Create New Session URL
  
Create New Session URL
Create a session which contains the data that enables the CSP’s customers to access the ZSSP site without the need to authenticate.
Note the following:
The connection is terminated at the end of the session, when the user logs out.
The session also expires after 30 minutes of inactivity.
The URL cannot be reused.
 
 
method
url
POST
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 following is an example of a Json request body for https://zvm_ip:port/v1/zsspSessions.
 
{
  "LogoutRedirectUrl": "https://131.1.2.3:9672/zcm",
  "ZorgIdentifier": "e67ece8c-9365-4443-8b6b-90946df636b9",
  "ZorgUserName": "johndoe",
  "ZsspAddress": "127.0.0.1:9779"
}
 
Parameter
description
type
mandatory
default
LogoutRedirectUrl
The URL the customer is redirected to after logging out of the ZSSP or after 10 minutes of inactivity.
If this parameter is empty, the user will be redirected to the login page.
string
No
ZSSP Login Screen
ZorgIdentifier
The identifier of the ZORG.
string
Yes
-
ZorgUsername
The username that will appear in the events and tasks related to actions performed in the ZSSP site.
string
No
ZORG name without username
ZsspAddress
The base URL the CSP customer uses to access the ZSSP in the CSP’s portal.
string
Yes
-
 
Response In Json Format
The following is an example of a Json response for https://zvm_ip:port/v1/zsspSessions.
 
{
  "K6AKCNA6UEHA5A7CDSZAJBUCGH2V6LNXMB3DQ5CPWK83S8SAF84A"
}
 
Parameter
Description
ZsspSessionIdentifier
The ZSSP session identifier.
Back to ZSSP Sessions API
Back to All APIs