/oracle
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /oracle/db/mount | Retrieve a list containing summary information about all Oracle database Live Mounts. | query oracleLiveMounts | Available |
| GET /oracle/db/mount/{id} | Retrieve detailed information about a specified Live Mount of an Oracle database snapshot. | Available | |
| DELETE /oracle/db/mount/{id} | Request an asynchronous job to delete a specified Live Mount of an Oracle database snapshot. Poll the job status by using /oracle/request/{id}. | mutation deleteOracleMount | Available |
| GET /oracle/db/snapshot/{id} | Retrieve detailed information about a specified Oracle database snapshot. | Available | |
| DELETE /oracle/db/snapshot/{id} | Given a particular snapshot id, delete the corresponding Oracle database snapshot. | -> Use mutation DeleteUnmanagedSnapshotsMutation | Restricted |
| GET /oracle/db/{id} | Retrieve detailed information for a specified Oracle database object. This endpoint will be removed in Rubrik CDM 7.0 in favor of GET v1/oracle/db/{id}. |
query oracleDatabase | Available |
| PATCH /oracle/db/{id} | Update properties of an Oracle database object. This endpoint will be removed in Rubrik CDM 7.0 in favor of PATCH v1/oracle/db/{id}. |
--> use mutation bulkUpdateOracleDatabases instead | Restricted |
| POST /oracle/db/{id}/export | Request an asynchronous job to export an Oracle database from a specified snapshot or timestamp. | mutation exportOracleDatabase | Available |
| POST /oracle/db/{id}/export/tablespace | Request an asynchronous job to export an Oracle tablespace from a specified snapshot or timestamp. | mutation exportOracleTablespace | Available |
| POST /oracle/db/{id}/log_backup | Create an asynchronous job for an on-demand backup of an Oracle database log. The response includes an ID for the asynchronous job request. To see the status of the request, poll /oracle/request/{id}. | mutation takeOnDemandOracleLogSnapshot | Available |
| GET /oracle/db/{id}/missed_recoverable_range | Retrieve a list of missed recoverable ranges for a Oracle database. For each run of one type of error, the first and last occurrence of the error are given. | query oracleMissedRecoverableRanges | Available |
| GET /oracle/db/{id}/missed_snapshot | Retrieve summary information about the missed snapshots of an Oracle database. | query oracleMissedSnapshots | Available |
| POST /oracle/db/{id}/mount | Create an asynchronous job to Live Mount an Oracle database from a snapshot. | mutation mountOracleDatabase | Available |
| POST /oracle/db/{id}/recover | Creates an instant recover request that restores a target database from the given snapshot. | mutation instantRecoverOracleSnapshot | Available |
| GET /oracle/db/{id}/recoverable_range | Retrieve the recoverable ranges for a specified Oracle database. A begin and/or end timestamp can be provided to retrieve only the ranges that fall within the window. | query oracleRecoverableRanges | Available |
| GET /oracle/db/{id}/snapshot | Retrieve summary information about the snapshots of a specified Oracle database object. | Available | |
| POST /oracle/db/{id}/snapshot | Create an asynchronous job for an on-demand snapshot of an Oracle database. The response includes an ID for the asynchronous job request. To see the status of the request, poll /oracle/request/{id}. | mutation takeOnDemandOracleDatabaseSnapshot | Available |
| DELETE /oracle/db/{id}/snapshot | Delete all snapshots for a specified Oracle database object. For the operation to succeed the referenced database must not be assigned to an SLA Domain. | mutation deleteAllOracleDatabaseSnapshots | Restricted |
| GET /oracle/host | Retrieve an array containing summary information for the Oracle Host objects on the Rubrik cluster. | query oracleTopLevelDescendants (with type filter) | Available |
| GET /oracle/host/{id} | Retrieve detailed information for a specified Oracle Host object. | query oracleHost | Available |
| PATCH /oracle/host/{id} | Update properties of an Oracle Host object. | --> use mutation bulkUpdateOracleHosts instead | Restricted |
| GET /oracle/rac | Retrieve an array containing summary information for the Oracle RAC objects on the Rubrik cluster. | query oracleTopLevelDescendants (with type filter) | Available |
| GET /oracle/rac/{id} | Retrieve detailed information for a specified Oracle RAC object. | query oracleRac | Available |
| PATCH /oracle/rac/{id} | Update properties of an Oracle RAC object. | --> use mutation bulkUpdateOracleRacs instead | Restricted |
| GET /oracle/request/{id} | Retrieve the task object for a specified Oracle database asynchronous request. | Available |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /oracle/aco_example_download_link | Link to download the Advanced Recovery Options example file which can be used to customize Oracle recoveries. | query oracleAcoExampleDownloadLink | Available |
| GET /oracle/aco_parameter_list | Get the list of supported Advanced Cloning Options (ACO) parameters. | query oracleAcoParameters | Available |
| PATCH /oracle/data_guard_group/{id} | Update properties of an Oracle Data Guard group object. | mutation updateOracleDataGuardGroup | Restricted |
| GET /oracle/db | Retrieves an array containing summary information about the Oracle database objects in the Rubrik cluster. | query oracleDatabases | Available |
| PATCH /oracle/db/bulk | Update the properties of the objects that represent the specified Oracle Databases. | mutation bulkUpdateOracleDatabases | Restricted |
| GET /oracle/db/{id} | Retrieves detailed information for a specified Oracle database object. | query oracleDatabase | Available |
| PATCH /oracle/db/{id} | Updates the properties of a specified Oracle database object. | Restricted | |
| DELETE /oracle/db/{id}/downloaded_snapshots | Requests an asynchronous job to expire downloaded database snapshots taken during a specified time period as well as log snapshots that contain any logs with timestamps within that time period. | -> API-only in CDM, not in RSC | Restricted |
| POST /oracle/db/{id}/pdb_details | Retrieves information about available pluggable databases (PDBs) for a given recovery point. | query oraclePdbDetails | Available |
| POST /oracle/db/{id}/refresh | Starts an asynchronous job to refresh the Oracle database metadata by querying the database instances on all the underlying hosts. | mutation refreshOracleDatabase | Available |
| GET /oracle/db/{id}/restore_estimate | The estimated size of the data to download from an archival location in order to perform a specified restore or export operation. | Available | |
| POST /oracle/db/{id}/restore_logs | Starts an asynchronous job to restore archive logs of an Oracle database. | mutation restoreOracleLogs | Available |
| POST /oracle/db/{id}/restore_pdb | Initiates an asynchronous request to restore PDBs on an Oracle database from a specified snapshot or timestamp. | mutation createOraclePdbRestore | Available |
| POST /oracle/db/{id}/validate | Queue a job to validate Oracle backups for a database snapshot or a specified timestamp. | mutation validateOracleDatabaseBackups | Available |
| PATCH /oracle/host/bulk | Update properties to Oracle Host objects. | mutation bulkUpdateOracleHosts | Restricted |
| PATCH /oracle/rac/bulk | Update the properties of the objects that represent the specified Oracle RAC. | mutation bulkUpdateOracleRacs | Restricted |
| POST /oracle/validate_aco_file | Validate the provided Oracle ACO (Advanced Cloning Options) file. | mutation validateOracleAcoFile | Available |