REST API for Oracle Database Classic Cloud Service

All REST Endpoints

Access Rules

View and manage the Oracle Compute Cloud Service security rules for Database Classic Cloud Service instances.

Create a Rule: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/accessrules
Enable, Disable or Delete a Rule: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/accessrules/{ruleName}
View All Rules: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/accessrules

Backup and Recovery

REST endpoints to manage backup and recovery operations on Database Classic Cloud Service instances.

Start a Backup Operation: Method: post
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups
Start a Recovery Operation: Method: post
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups/recovery
View All Backup Operations: Method: get
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups
View All Recovery Operations: Method: get
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups/recovery/history

IP Reservations

REST endpoints to create, view and delete IP reservations for Database Classic Cloud Service instances.

These endpoints are available only in Cloud accounts that support Oracle Cloud Infrastructure Classic regions.

Create an IP Reservation: Method: post
Path: /paas/api/v1.1/network/{identityDomainId}/services/dbaas/ipreservations
Delete an IP Reservation: Method: delete
Path: /paas/api/v1.1/network/{identityDomainId}/services/dbaas/ipreservations/{ipResName}
View All IP Reservations: Method: get
Path: /paas/api/v1.1/network/{identityDomainId}/services/dbaas/ipreservations

Patches

REST endpoints to precheck, apply and roll back patches on Database Classic Cloud Service instances.

Apply a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/{patchId}
Precheck Application of a Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/{patchId}
Roll Back an Applied Patch: Method: put
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/{rollbackId}/rollback
View a List of Applied and Rolled Back Patches: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied
View a List of Available Patches: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/available
View a List of Patch Precheck Operations: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks
View Job Status of a Patch Application or Rollback Operation: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied/job/{jobId}
View Job Status of a Patch Precheck Operation: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/job/{jobId}

SSH Keys

View and manage secure shell (SSH) public keys for Database Classic Cloud Service instances.

Add an SSH Public Key: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/crednames/{credentialName}
View an SSH Key's Details: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/{credentialName}
View an SSH Key's Summary: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/crednames/{credentialName}
View Selected SSH Keys' Details: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials
View Selected SSH Keys' Summaries: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials/crednames
View Status of an Add SSH Key Job: Method: get
Path: /paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}

Service Instances

REST endpoints to create and manage Database Classic Cloud Service instances.

Change Roles in a Data Guard Configuration: Method: post
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/standby
Create a Service Instance: Method: post
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}
Delete a Service Instance: Method: delete
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}
Monitor a Service Instance: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/healthcheck
Replace an Existing Instance's Database Using a Cloud Backup: Method: put
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/ibkup
Scale a Service Instance: Method: put
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}
Stop, Start or Restart a Service Instance or Compute Node: Method: post
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}
View a Service Instance: Method: get
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}
View a Service Instance's Compute Nodes: Method: get
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers
View All Service Instances: Method: get
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}
View the Job Status of an Operation: Method: get
Path: /paas/service/dbcs/api/v1.1/instances/{identityDomainId}/status/{requestName}/job/{jobId}

Snapshots

REST endpoints to create, view and delete storage snapshots of Database Classic Cloud Service instances.

Create a Snapshot: Method: post
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/snapshots
Delete a Snapshot: Method: delete
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/snapshots/{snapshotName}
View a Snapshot: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/snapshots/{snapshotName}
View All Snapshots: Method: get
Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/snapshots