ZSSP Sessions API

Using this API, the Managed Service Provider MSP can provide the user a way to access the ZSSP without the need to authenticate. For example, if the ZSSP is integrated in MSP portal, either as separate pages or as an iFrame inside the page of the MSP portal, additional authenticating to ZSSP will not be required.

Required privileges: Manage site permissions.

Sessions for Windows Platform

Create New Session URL

Create a session which contains the data that enables the MSP’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 MSP customer uses to access the ZSSP in the MSP’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

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 MSP’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.

Delete a Specific Session URL

Delete a session of integrated URL.

Method	URL
DELETE	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 response Json body is empty.

Sessions for Linux Platform

Create New Session URL

Create a session which contains the data that enables the MSP’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": "10.171.80.158/zssp",
  "ZorgIdentifier": "5eb810c8-c730-4824-a5ce-66be8463e2bc",
  "ZorgUserName": "TestUser1",
  "ZsspAddress": "10.171.80.158"
}

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	Yes	ZORG name without username
ZsspAddress	The base URL the MSP customer uses to access the ZSSP in the MSP’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.

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}

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 MSP’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. This parameter is mandatory for the request.
ZsspAddress	The address of the URL which the customer uses for browsing to access the ZSSP site.
ZsspSessionIdentifier	The identifier of the ZSSP session.

Delete a Specific Session URL

Delete a session of integrated URL.

Method	URL
DELETE	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 response JSON body is empty.