How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Database Recovery API

The databaseRecovery API from Oracle — 20 operation(s) for databaserecovery.

Oracle Database Recovery API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 32 operations across 20 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 20210216.

Requests are made against 2 base URLs: http://127.0.0.1/20210216, https://127.0.0.1/20210216.

32 operations 20 paths 40 schemas 4 DELETE12 GET12 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20210216
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 32

Across 20 paths, the API surfaces 32 operations — 4 DELETE, 12 GET, 12 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

databaseRecovery 32
GET
/longTermBackups
Gets a list of all long term backups in a compartment
ListLongTermBackups 10 params → 200400401404429500default
POST
/longTermBackups
Creates a new long-term backup for the protected database with OCID
CreateLongTermBackup 2 params body → 201400401404409429500default
DELETE
/longTermBackups/{longTermBackupId}
Delete a LongTermBackup
DeleteLongTermBackup 3 params → 202400401404412429500default
GET
/longTermBackups/{longTermBackupId}
Get Long Term Backup
GetLongTermBackup 2 params → 200400401404429500default
PUT
/longTermBackups/{longTermBackupId}
Update the long term backup identified by the id
UpdateLongTermBackup 3 params body → 202400401404405412429500
POST
/longTermBackups/{longTermBackupId}/actions/cancel
Cancels scheduled long-term backup identified by longTermBackupId
CancelLongTermBackup 4 params → 202400401404409412429500
GET
/protectedDatabases
Gets a list of all Protected Databases in a compartment
ListProtectedDatabases 12 params → 200400401404429500default
POST
/protectedDatabases
Creates a new Protected Database
CreateProtectedDatabase 3 params body → 201204400401404409429500
DELETE
/protectedDatabases/{protectedDatabaseId}
Delete a provisioned Protected Database
DeleteProtectedDatabase 4 params → 202400401404412429500default
GET
/protectedDatabases/{protectedDatabaseId}
Get Protected Database
GetProtectedDatabase 2 params → 200400401404429500default
PUT
/protectedDatabases/{protectedDatabaseId}
Update the Protected Database identified by the id
UpdateProtectedDatabase 3 params body → 202400401404405412429500
POST
/protectedDatabases/{protectedDatabaseId}/actions/cancelDeletion
Cancel the scheduled deletion of the protected database
CancelProtectedDatabaseDeletion 4 params → 204400401404409412429500
POST
/protectedDatabases/{protectedDatabaseId}/actions/changeCompartment
Moves a resource into a different compartment.
ChangeProtectedDatabaseCompartment 4 params body → 202401404409412429500
POST
/protectedDatabases/{protectedDatabaseId}/actions/changeSubscription
Associates the protected database with a new cloud service environment, such as Microsoft Azure.
ChangeProtectedDatabaseSubscription 4 params body → 202400401404409412429500
POST
/protectedDatabases/{protectedDatabaseId}/actions/getConfiguration
Get Protected Database tnssnames.ora file
FetchProtectedDatabaseConfiguration 4 params body → 200400401404409412429500
POST
/protectedDatabases/{protectedDatabaseId}/actions/scheduleDeletion
Schedule deletion of the protected database
ScheduleProtectedDatabaseDeletion 4 params body → 202400401404409412429500
GET
/protectionPolicies
Gets a list of all ProtectionPolicies in a compartment
ListProtectionPolicies 10 params → 200400401404429500default
POST
/protectionPolicies
Creates a new Protection Policy
CreateProtectionPolicy 2 params body → 201400401404409429500default
DELETE
/protectionPolicies/{protectionPolicyId}
Delete a provisioned Protection Policy
DeleteProtectionPolicy 3 params → 202400401404412429500default
GET
/protectionPolicies/{protectionPolicyId}
Get Protection Policy
GetProtectionPolicy 2 params → 200400401404429500default
PUT
/protectionPolicies/{protectionPolicyId}
Update the Protection Policy identified by the id
UpdateProtectionPolicy 3 params body → 202400401404405412429500
POST
/protectionPolicies/{protectionPolicyId}/actions/changeCompartment
Moves a resource into a different compartment.
ChangeProtectionPolicyCompartment 4 params body → 202401404409412429500
GET
/recoveryServiceSubnets
Gets a list of recovery service subnet resources based on the specified parameters.
ListRecoveryServiceSubnets 10 params → 200400401404429500default
POST
/recoveryServiceSubnets
Creates a new recovery service subnet.
CreateRecoveryServiceSubnet 2 params body → 201400401404409429500default
DELETE
/recoveryServiceSubnets/{recoveryServiceSubnetId}
Deletes a specified recovery service subnet.
DeleteRecoveryServiceSubnet 3 params → 202400401404412429500default
GET
/recoveryServiceSubnets/{recoveryServiceSubnetId}
Get Recovery Service Subnet
GetRecoveryServiceSubnet 2 params → 200400401404429500default
PUT
/recoveryServiceSubnets/{recoveryServiceSubnetId}
Update the Recovery Service Subnet identified by the id
UpdateRecoveryServiceSubnet 3 params body → 202400401404405412429500
POST
/recoveryServiceSubnets/{recoveryServiceSubnetId}/actions/changeCompartment
Moves a resource into a different compartment.
ChangeRecoveryServiceSubnetCompartment 4 params body → 202401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 9 params → 200400401404429500default
GET
/workRequests/{workRequestId}
GET Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ProtectedDatabase (27 properties), ProtectedDatabaseSummary (23 properties), LongTermBackup (21 properties), LongTermBackupSummary (21 properties). Each schema is shown below with its type and property counts.

RecoveryServiceSubnetDetails
object
Details of the Recovery Service Subnet.
2 properties 1 required
CreateLongTermBackupDetails
object
Describes the parameters required to create an on demand long term backup.
7 properties 2 required
WorkRequestSummary
object
A summary of the status of a work request.
9 properties 7 required
ProtectedDatabaseSummary
object
A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a r…
23 properties 6 required
WorkRequestSummaryCollection
object
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
1 property 1 required
ChangeRecoveryServiceSubnetCompartmentDetails
object
The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment.
1 property 1 required
ProtectedDatabaseCollection
object
Results of a protected database search operation. The results contain protected database summary and metadata information.
1 property 1 required
LongTermBackupCollection
object
Results of a long term backup search. Contains both long term backup Summary items and other information, such as metadata.
1 property 1 required
WorkRequestErrorCollection
object
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
1 property 1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
Metrics
object
Backup performance and storage utilization metrics for the protected database.
8 properties
ScheduleProtectedDatabaseDeletionDetails
object
The details for scheduling deletion of the protected database
1 property
CreateRecoveryServiceSubnetDetails
object
Describes the parameters required to create a Recovery Service Subnet.
8 properties 3 required
ProtectionPolicyCollection
object
Results of a Protection Policy search. Contains both Protection Policy Summary items and other information, such as metadata.
1 property 1 required
RecoveryServiceSubnetCollection
object
Results of a recovery service subnet search operation. The results contain recovery service subnet summary and metadata information.
1 property 1 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
UpdateProtectionPolicyDetails
object
The information to be updated.
5 properties
ChangeProtectedDatabaseCompartmentDetails
object
The configuration details required to move a protected database from the existing compartment to a specified compartment.
1 property 1 required
MetricsSummary
object
Backup performance and storage utilization metrics for the Protected Database.
8 properties
UpdateRecoveryServiceSubnetDetails
object
Describes the parameters required to update a recovery service subnet.
5 properties
ChangeProtectionPolicyCompartmentDetails
object
The configuration details required to move a protection policy from the existing compartment to a specified compartment.
1 property 1 required
CreateProtectedDatabaseDetails
object
Describes the parameters required to create a protected database.
15 properties 6 required
UpdateProtectedDatabaseDetails
object
Describes the parameters required to update a protected database.
9 properties
WorkRequest
object
A description of workrequest status
9 properties 7 required
ProtectionPolicy
object
The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected d…
14 properties 4 required
CreateProtectionPolicyDetails
object
Describes the parameters required to create a custom protection policy.
7 properties 3 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties 3 required
ProtectionPolicySummary
object
Recovery Service enables policy driven backup storage management. To use any of the API operations, you must be authorized in an IAM policy. If you are not aut…
14 properties 4 required
RecoveryServiceSubnetSummary
object
Each Recovery Service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the…
14 properties 4 required
LongTermBackup
object
The details of a Long Term Backup.
21 properties 6 required
WorkRequestLogEntryCollection
object
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
1 property 1 required
UpdateLongTermBackupDetails
object
The information to be updated.
4 properties
ChangeProtectedDatabaseSubscriptionDetails
object
Subscription details of the new cloud service environment, such as Microsoft Azure, where the protected database will be provisioned.
2 properties
RecoveryServiceSubnet
object
The details of a recovery service subnet. Recovery service subnets allows Recovery Service to access protected databases in each VCN. Each recovery service sub…
14 properties 4 required
ProtectedDatabase
object
A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a r…
27 properties 7 required
Error
object
Error Information.
2 properties 2 required
RecoveryServiceSubnetInput
object
Parameters to retrieve information about a specific recovery service subnet.
1 property 1 required
FetchProtectedDatabaseConfigurationDetails
object
Provides which configuration details to get.
1 property
LongTermBackupSummary
object
Generate an on-demand backup and retain it long-term as per the LTR backup retention period specified.
21 properties 6 required
RetentionPeriodValue
object
Specifies the retention period for the long-term backup.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-databaserecovery-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Database Recovery API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.