[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Get Remote Session

Description

Returns information about the current session to the remote Site Recovery Manager server, if any.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/remote-session
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SessionInfo of type application/json

Returns information about the currently authenticated remote session.

{
	"username": "string"
}
string
username Optional
Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/pairings/{pairing_id}/remote-session
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-remote-site-connectivity-contract:
    not-authenticated: ERROR
    server-down: ERROR


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Feedback

Was this page helpful?