# Oracle Database ORDS REST Services API

**Canonical:** https://apis.io/apis/oracle-database/oracle-database-ords-rest-services-api/  
**Provider:** Oracle Database — https://apis.io/providers/oracle-database/  
**Documentation:** https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/

Oracle Database ORDS REST Services API is one of 42 APIs that [Oracle Database](https://apis.io/providers/oracle-database/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include ORDS REST Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Custom Oracle REST Data Services built with SQL & PL/SQL.

## Operations (46)

| Method | Path | Summary |
|---|---|---|
| GET | `/ords/properties/{key}` | Get an ORDS property value |
| GET | `/ords/properties/{schema}/{key}` | Get an ORDS property value for a schema |
| PUT | `/ords/properties/{schema}/{key}` | Set an ORDS property value for a schema |
| DELETE | `/ords/properties/{schema}/{key}` | Unset an ORDS property value for a schema |
| GET | `/ords/rest/modules/{id}` | Get a REST module |
| GET | `/ords/rest/modules/{id}/source` | Get a REST module source |
| GET | `/ords/rest/templates/` | Get all REST module templates |
| POST | `/ords/rest/templates/` | Create a REST module template |
| GET | `/ords/rest/templates/{id}` | Get a REST module template |
| PUT | `/ords/rest/templates/{id}` | Update a REST module template |
| DELETE | `/ords/rest/templates/{id}` | Delete a REST module template |
| GET | `/ords/rest/handlers/{id}` | Get a REST template handler |
| PUT | `/ords/rest/handlers/{id}` | Update a REST template handler |
| GET | `/ords/rest/handlers/{id}/source` | Get a REST handler source |
| GET | `/ords/rest/parameters/` | Get all REST handler parameters |
| POST | `/ords/rest/parameters/` | Create a REST handler parameter |
| GET | `/ords/rest/parameters/{id}` | Get a REST handler parameter |
| PUT | `/ords/rest/parameters/{id}` | Update a REST handler parameter |
| DELETE | `/ords/rest/parameters/{id}` | Delete a REST handler parameter |
| GET | `/ords/rest/roles/` | Get all ORDS roles |
| GET | `/ords/rest/roles/{id}` | Get an ORDS role |
| PUT | `/ords/rest/roles/{id}` | Update an ORDS role |
| DELETE | `/ords/rest/roles/{id}` | Delete an ORDS role |
| GET | `/ords/rest/roles/{id}/privileges/` | Get all ORDS privileges for a specific role |
| GET | `/ords/rest/privileges/` | Get all ORDS privileges |
| GET | `/ords/rest/privileges/{id}` | Get an ORDS privilege |
| PUT | `/ords/rest/privileges/{id}` | Update an ORDS privilege |
| DELETE | `/ords/rest/privileges/{id}` | Delete an ORDS privilege |
| GET | `/ords/rest/privileges/{id}/modules/` | Get all REST modules in a privilege |
| GET | `/ords/rest/privileges/{id}/patterns/` | Get all REST patterns in a privilege |
| GET | `/ords/rest/privileges/{id}/roles/` | Get all ORDS roles in a privilege |
| GET | `/ords/rest/privilege/modules/` | Get all protected REST modules |
| GET | `/ords/rest/clients/{id}` | Get an ORDS OAuth client |
| DELETE | `/ords/rest/clients/{id}` | Delete an ORDS OAuth client |
| POST | `/ords/rest/clients/{id}/logo/` | Updates the ORDS OAuth client avatar image |
| POST | `/ords/rest/clients/{id}/secret/{slotid}` | Register or Rotate the ORDS OAuth client secret |
| DELETE | `/ords/rest/clients/{id}/secret/{slotid}` | Revoke the ORDS OAuth client secret |
| GET | `/ords/rest/clients/{id}/privileges/` | Get all ORDS privileges in an OAuth client |
| GET | `/ords/rest/clients/{id}/roles/` | Get all ORDS roles in an OAuth client |
| GET | `/ords/rest/autorest/` | Get all REST enabled objects |
| GET | `/ords/rest/autorest/{id}` | Get a REST enabled object |
| PUT | `/ords/rest/autorest/{id}` | Update or disables a REST enabled object |
| GET | `/ords/rest/autorest/summary` | Get count of all the REST enabled objects |
| GET | `/ords/rest/autorest/{id}/metadata` | Get a REST enabled object metadata |
| GET | `/ords/rest/overview/` | Get current ORDS schema and count of all current schema REST objects and count… |
| GET | `/ords/rest/overview/objects_recent` | Get all current schema recent REST objects |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/openapi/oracle-database-ords-rest-services-api-openapi.yml
- **Documentation** — https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/26.1/orrst/index.html
- **APIReference** — https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/26.1/orrst/rest-endpoints.html

## Other Oracle Database APIs (12)

- [Oracle Database API for MongoDB](https://apis.io/apis/oracle-database/oracle-database-api-for-mongodb/)
- [Oracle Database JDBC](https://apis.io/apis/oracle-database/oracle-database-jdbc/)
- [Oracle Call Interface (OCI)](https://apis.io/apis/oracle-database/oracle-call-interface-oci/)
- [Oracle SQL Developer REST API](https://apis.io/apis/oracle-database/oracle-sql-developer-rest-api/)
- [Oracle Transactional Event Queues (TxEventQ)](https://apis.io/apis/oracle-database/oracle-transactional-event-queues-txeventq/)
- [Oracle Database APEX API](https://apis.io/apis/oracle-database/oracle-database-apex-api/)
- [Oracle Database Autonomous Databases API](https://apis.io/apis/oracle-database/oracle-database-autonomous-databases-api/)
- [Oracle Database Backups API](https://apis.io/apis/oracle-database/oracle-database-backups-api/)
- [Oracle Database Bulk Operations API](https://apis.io/apis/oracle-database/oracle-database-bulk-operations-api/)
- [Oracle Database Collections API](https://apis.io/apis/oracle-database/oracle-database-collections-api/)
- [Oracle Database Data Dictionary API](https://apis.io/apis/oracle-database/oracle-database-data-dictionary-api/)
- [Oracle Database Data Guard API](https://apis.io/apis/oracle-database/oracle-database-data-guard-api/)

## Tags

ORDS REST Services

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/oracle-database/oracle-database-ords-rest-services-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/oracle-database/.