How to get the session_id access to VLR/VR Explore REST APIs
search cancel

How to get the session_id access to VLR/VR Explore REST APIs

book

Article ID: 341847

calendar_today

Updated On:

Products

VMware Live Recovery

Issue/Introduction

How to get the session_id to use in REST API commands in VLR/VR

Environment

VMware vSphere Replication 8.x
VMware Site Recovery Manager 8.x
VMware Live Site Recovery 9.x

Resolution

* Before proceeding clarify which API you wish to connect to. For SRM use the SRM server url, for VR use the VR server url.

* To launch the SRM UI - https://srm-fqdn/ and Select Explore REST API

* To launch the VR UI - https://vr-fqdn/ and Select Explore REST API

 

 

* Go to API Categories/authentication POST method and Execute it with relevant credentials.  

-     For configure APIs ( admin/password)

-      For srm/vr APIS ([email protected]/password)

 

 

* Note the session_id returned from the Execute response output. This id is then used to authenticate the other REST API calls.

 

 

* Enter the returned session_id in the top window. Session ID (response from POST /session)

 

 

 

 

* Now you can try using the other GET POST REST API call

eg:  Appliance GET – List appliance information

 

 

 

 

* You can view the metadata and format of the response output

* It also constructs the syntax of the CURL cmd for sue in scripting REST API call.

 

Additional Information

 

List of Site Recovery Manager REST APIs : https://techdocs.broadcom.com/us/en/vmware-cis/live-recovery/site-recovery-manager/8-8/site-recovery-manager-administration-8-8/using-the-site-recovery-manager-rest-api-gateway/list-of-site-recovery-manager-rest-apis/list-of-site-recovery-manager-rest-api-2.html

List of vSphere Replication REST APIs https://techdocs.broadcom.com/us/en/vmware-cis/live-recovery/vsphere-replication/9-0/vr-help-plug-in-9-0/using-the-vsphere-replication-rest-api-gateway/list-of-vsphere-replication-rest-apis.html

Using the Site Recovery Manager REST API Gateway: https://techdocs.broadcom.com/us/en/vmware-cis/live-recovery/site-recovery-manager/8-8/site-recovery-manager-administration-8-8/using-the-site-recovery-manager-rest-api-gateway.html

How to use the REST APIs to run a recovery plan: https://techdocs.broadcom.com/us/en/vmware-cis/live-recovery/site-recovery-manager/8-8/site-recovery-manager-administration-8-8/using-the-site-recovery-manager-rest-api-gateway/how-to-use-the-rest-apis-to-run-a-recovery-plan.html