# Oracle Partitioning ORDS REST Services API

**Canonical:** https://apis.io/apis/oracle-partitioning/oracle-partitioning-ords-rest-services-api/  
**Provider:** Oracle Partitioning — https://apis.io/providers/oracle-partitioning/  
**Base URL:** https://{server}/{context-root}/{database}/{schema}/_/db-api/stable  
**Documentation:** https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/

Oracle Partitioning ORDS REST Services API is one of 25 APIs that [Oracle Partitioning](https://apis.io/providers/oracle-partitioning/) 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 (60 of 61)

| Method | Path | Summary |
|---|---|---|
| GET | `/ords/properties/` | Get all ORDS properties values |
| GET | `/ords/properties/{key}` | Get an ORDS property value |
| PUT | `/ords/properties/{key}` | Set an ORDS property value |
| DELETE | `/ords/properties/{key}` | Unset 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/` | Get all REST modules |
| POST | `/ords/rest/modules/` | Create a REST module |
| GET | `/ords/rest/modules/{id}` | Get a REST module |
| PUT | `/ords/rest/modules/{id}` | Update 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/` | Get all REST template handlers |
| POST | `/ords/rest/handlers/` | Create a REST template handler |
| GET | `/ords/rest/handlers/{id}` | Get a REST template handler |
| PUT | `/ords/rest/handlers/{id}` | Update a REST template handler |
| DELETE | `/ords/rest/handlers/{id}` | Delete 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 |
| POST | `/ords/rest/roles/` | Create an ORDS role |
| 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 |
| POST | `/ords/rest/privileges/` | Create an ORDS privilege |
| 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/` | Get all ORDS OAuth clients |
| POST | `/ords/rest/clients/` | Create an ORDS OAuth client |
| GET | `/ords/rest/clients/{id}` | Get an ORDS OAuth client |
| PUT | `/ords/rest/clients/{id}` | Update 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 |
| POST | `/ords/rest/autorest/` | REST enable an object |
| 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 of all REST modules |

…and 1 more operations. They are listed in full on the page.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/oracle-partitioning/refs/heads/main/openapi/oracle-partitioning-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
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/oracle-partitioning/refs/heads/main/errors/oracle-partitioning-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/oracle-partitioning/refs/heads/main/data-model/oracle-partitioning-data-model.yml

## Other Oracle Partitioning APIs (12)

- [Oracle SQL Developer REST Services - Partitioning](https://apis.io/apis/oracle-partitioning/oracle-sql-developer-rest-services-partitioning/)
- [Oracle Cloud Infrastructure Database API - Partitioning](https://apis.io/apis/oracle-partitioning/oracle-cloud-infrastructure-database-api-partitioning/)
- [Oracle Partitioning Data Dictionary API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-data-dictionary-api/)
- [Oracle Partitioning Data Guard API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-data-guard-api/)
- [Oracle Partitioning Data Pump API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-data-pump-api/)
- [Oracle Partitioning Data Tools API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-data-tools-api/)
- [Oracle Partitioning Environment API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-environment-api/)
- [Oracle Partitioning General API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-general-api/)
- [Oracle Partitioning Monitoring API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-monitoring-api/)
- [Oracle Partitioning Open Service Broker API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-open-service-broker-api/)
- [Oracle Partitioning Oracle APEX API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-oracle-apex-api/)
- [Oracle Partitioning Oracle Transactional Event Queues API](https://apis.io/apis/oracle-partitioning/oracle-partitioning-oracle-transactional-event-queues-api/)

## Tags

ORDS REST Services

---

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