Rubrik REST API

Copyright © 2017-2021 Rubrik Inc. [Legal]( section/Legal) Introduction Welcome to the Rubrik™ REST API documentation. The Rubrik REST API provides a RESTful interface for working with Rubrik clusters and Rubrik Edge virtual appliances. The Rubrik REST API can be used to query, configure, and control nearly all of the operations of the Rubrik software. Through authenticated and encrypted interaction with the Rubrik REST API server, perform any of the operations that are available through the Rubrik web UI and many bulk-type operations that might otherwise be difficult or impossible to perform. This documentation provides reference information and examples of typical workflows for the Rubrik REST API. For more detailed information about working with Rubrik clusters and Rubrik Edge virtual appliances refer to the Rubrik User Guide . A quick way to become familiar with the Rubrik REST API, is to use the Rubrik REST API Explorer. [OpenAPI]( section/OpenAPI) describes this tool. Refer to the [changelog]( section/Changelog) to see information about changes within this version of the Rubrik REST API. Changelog Revisions are listed with the most recent revision first. Changes to V1 API in Rubrik Version 6.0.0 Feature additions/improvements: Added optional fields: id(type: string) and networkType(type: VmwareNetworkType Enum) to VmwareNetworkInfo, which is used by: Get /vmware/vm/{id}/snapshot Get /vmware/config/recovery/networks Added new optional field maxLocalRetentionLimit to CloudOutForecastSlaParameters . Added following new endpoints for health monitor: POST /health monitor/run policy GET /health monitor/policies GET /health monitor/policy status Added new endpoints POST /sap hana/db/{id}/configure restore and /sap hana/db/{id}/unconfigure restore to configure and unconfigure system copy restore on the target SAP HANA database. Added new endpoint POST /sla domain/assign to downloaded snapshots to assign retention SLA only to snapshots at downloaded locations. Copied the following endpoints from the internal Rubrik REST API listing to the v1 listing: GET /oracle/db GET /oracle/db/{id} PATCH /oracle/db/{id} Added a new optional parameter is data guard group to GET /oracle/db . Added new optional fields advancedRecoveryConfigMap , preScriptPath , postScriptPath , and shouldStopRecoveryOnPreScriptFailure to ExportOracleDbConfig and MountOracleDbConfig which specify the Advanced Cloning Options (ACO) map, pre script path, post script path, and whether to stop the recovery on pre-script failure, respectively. Added new endpoint POST /oracle/validate aco file to validate the given Advanced Cloning Options (ACO) file and retrieve the validation results. Added new endpoint GET /oracle/aco parameter list to fetch the list of supported Advanced Cloning Options (ACO) parameter names. Added new endpoint PATCH /oracle/data guard group/{id} to update the SLA and user settings for a Data Guard group. Added new endpoints to get and change hostnames of nodes in a Rubrik cluster. 'GET /cluster/{id}/node hostname', 'POST /cluster/{id}/node hostname'. Added a new object NodeHostnameInfo used by GET /cluster/{id}/node hostname and POST /cluster/{id}/node hostname . Added new endpoint to get Rubrik Backup Service details for a host. GET /host/rbs Added new endpoint to install Rubrik Backup Service on a host. POST /host/rbs/install Added new endpoint to uninstall Rubrik Backup Service from a host. POST /host/rbs/uninstall Added new endpoint to upgrade Rubrik Backup Service on a host. POST /host/rbs/upgrade Added new endpoints for user-defined tags management GET /user defined tag POST /user defined tag DELETE /user defined tag GET /user defined tag/{id} PATCH /user defined tag/{id} DELETE /user defined tag/{id} Added new optional field 'numChannels' to 'OracleValidateConfig' object. This field specifies the number of channels used when validating Oracle backups. Added new endpoint for batch VM snpshots query. POST /vmware/vm/snapshots Added new endpoin…