About the REST APIs

Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.

To install and configure Oracle REST Data Services refer to the Oracle® REST Data Services Installation and Configuration Guide.

An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration.

The pattern for the API document URL is:

https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path>

Where, the <my database> and <my schema> variables can be optional, depending on the ORDS configuration and the service invoked.

You can view a list of all REST endpoints in this API.