VMware Live Site Recovery Configuration REST APIs Gateway provides an API access to the VMware Live Site Recovery Virtual Appliance.
The Configuration REST APIs Gateway allows you to programmatically perform various configuration tasks without the use of the VMware Live Site Recovery Virtual Appliance Management Interface.
SRM Configuration REST API Gateway
To access the VMware Live Site Recovery Configuration REST API Gateway documentation and guidelines, see https://developer.broadcom.com/xapis/srm-appliance-config-api/latest/.
Appliance REST APIs
| 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 | Restart the virtual appliance. |
| Appliance | POST | Shutdown Appliance | Shut down the virtual appliance. |
VMware Live Site Recovery 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. |
VMware Live Site Recovery REST APIs for Authentication
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Authentication | GET | Get Current Session | Return 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. |
VMware Live Site Recovery 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. |
VMware Live Site Recovery 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 | Validate connections to the vSphere infrastructure. |
VMware Live Site Recovery 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. |
VMware Live Site Recovery 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. |
VMware Live Site Recovery 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. |
VMware Live Site Recovery 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. |
VMware Live Site Recovery REST APIs for Storage Replication Adapters
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Storage Replication Adapters | GET | Get All Storage Replication Adapters | Get all storage replication adapters available on the server. |
| Storage Replication Adapters | GET | Download SRA Configuration | Download configuration archive for a given storage replication adapter from the server. |
| Storage Replication Adapters | POST | Upload SRA Configuration | Upload configuration archive for a given storage replication adapter to the server. |
| Storage Replication Adapters | POST | Copy SRA Configuration | Configuration from the given storage replication adapter is copied over to a specified storage replication adapter. |
| Storage Replication Adapters | POST | Reset SRA Configuration | Reset configuration of a given storage replication adapter. |
| Storage Replication Adapters | POST | Reload Storage Replication Adapter | Reload a given storage replication adapter. |
| Storage Replication Adapters | POST | Create SRA | Create a new storage replication adapter by uploading an installation archive to the server. |
| Storage Replication Adapters | DELETE | Delete Storage Replication Adapter | Delete a given storage replication adapter. |
VMware Live Site Recovery REST APIs for Support Bundles
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Support Bundles | GET | Get Support Bundles | Get all support bundles available on the server. |
| Support Bundles | GET | Download Support Bundle | Download support bundle information from the server. |
| Support Bundles | POST | Generate Support Bundle | Generate support bundle. |
| Support Bundles | DELETE | Delete Support Bundle | Delete the existing support bundle on the server. |
