VMware Site Recovery Manager Configuration REST API Gateway provides an API access to the Site Recovery Manager Virtual Appliance and allows you to programmatically perform various configuration tasks without the use of the Site Recovery Virtual Appliance Management Interface.

SRM Configuration REST API Gateway

To access the Site Recovery Manager Configuration REST API Gateway documentation and guidelines, seehttps://developer.vmware.com/apis/srm-appliance-config-api/latest/ .

Appliance REST APIs

Table 1. Site Recovery Manager REST APIs Realated to Appliance Operations
Category Operation Type REST API Name Description
Appliance GET Get Appliance Disks Get information about the virtual appliance’s disks
Appliance GET Get Appliance Info Get information about the virtual appliance
Appliance POST Restart Appliance Restard the virtual appliance.
Appliance POST Shutdown Appliance Shut down the virtual appliance.

Site Recovery Manager REST APIs for Appliance Settings

Table 2. REST APIs for Appliance Settings
Category Operation Type REST API Name Description
Appliance Settings GET Get Syslog Servers List of all configured syslog servers
Appliance Settings GET Get Time Settings Information about current time settings
Appliance Settings GET Get Time Zones Information about supported time zones.
Appliance Settings POST Send Syslog Test Message Send test message to all syslog servers.
Appliance Settings POST Update Appliance Password Update appliance password.
Appliance Settings POST Update Database Password Update database password.
Appliance Settings PUT Update Syslog Servers Update configured syslog servers.
Appliance Settings PUT Update Time Settings Update current time settings.

Site Recovery Manager REST APIs for Authentication

Table 3. REST APIs for Authentication
Category Operation Type REST API Name Description
Authentication GET Get Current Session Returns information about the current session if any.
Authentication POST Login Logs in and returns the session id. Include ‘x-dr-session’ header with value the returned session id in subsequent requests.
Authentication DELETE Logout Logs out if the session is authenticated.

Site Recovery Manager REST APIs for Certificates

Table 4. REST APIs for Certificates
Category Operation Type REST API Name Description
Certificates POST Add CA Certificates Add certificate authorities (CA) certificates.
Certificates POST Delete CA Certificates Delete certificate authorities (CA) certificates.
Certificates POST Generate CSR Generate new key and certificate signing request (CSR) and return it for signing.
Certificates GET Get Appliance CA Certificates Get installed certificate authorities (CA) certificates used to validate other server’s certificates.
Certificates GET Get Appliance Certificate Get appliance certificate information.
Certificates POST Probe SSL Check if the appliance can establish successful SSL connection to the specified endpoint.
Certificates POST Update Appliance Certificate Update appliance certificate.

Site Recovery Manager REST APIs for Configuration

Table 5. REST APIs for Configuration
Category Operation Type REST API Name Description
Configuration POST Check Extension Key Check whether given extension key is already registered in SSO, lookup service and as vCenter Server extension.
Configuration POST Delete Configuration Remove current configuration.
Configuration GET Get Configuration Get appliance configuration information.
Configuration GET Get Reconfigure Required Check if reconfigure operation is required after upgrade.
Configuration POST List VC Services List all vCenter Server instances in the Platform Services Controller.
Configuration PUT Update Configuration Update appliance configuration
Configuration POST Validate Connection Validates connections to the vSphere infrastructure.

Site Recovery Manager REST APIs for Network Settings

Table 6. REST APIs for Network Settings
Category Operation Type REST API Name Description
Network Settings GET Get All Network Interfaces Settings Get all network interface settings.
Network Settings GET Get All Network Settings Current appliance network settings.
Network Settings GET Get Network DNS Settings Get DNS settings.
Network Settings GET Get Network Interface Settings Get network interface settings.
Network Settings PUT Update Network DNS Settings Update DNS settings.
Network Settings POST Update Network Interface Settings Update network interface settings.

Site Recovery Manager REST APIs for Services

Table 7. REST APIs for Services
Category Operation Type REST API Name Description
Services GET Get All Services Get information about all services.
Services GET Get Service Get information about a specific service.
Services POST Restart Service Restart the service.
Services POST Start Service Start the service.
Services POST Stop Service Stop the service.

Site Recovery Manager REST APIs for Tasks

Table 8. REST APIs for Tasks
Category Operation Type REST API Name Description
Tasks GET Get All Tasks Info Retrieve all configuration-related tasks.
Tasks GET Get Tasks Info Retrieve task information.

Site Recovery Manager REST APIs for Updates

Table 9. REST APIs for Updates
Category Operation Type REST API Name Description
Updates PUT Change Updates Repository Change current updates repository.
Updates POST Get Updates Get all available updates in the repository.
Updates GET Get Updates Repository Get information about the current updates repository.
Updates POST Install Update Install the update.