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 REST Services API

Custom REST API module, handler, and OAuth management

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

This API exposes 5 JSON Schema definitions.

Tagged areas include REST Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, an API reference, and 5 JSON Schemas.

This API exposes 15 operations across 11 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 25.4.0.

Requests are made against a single base URL, https://{host}:{port}/ords.

15 operations 11 paths 13 schemas 2 DELETE4 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
25.4.0
Server
https://{host}:{port}/ords
Authentication
OAuth 2.0, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Oracle Database REST Services API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials and authorizationCode flows. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 15

Across 11 paths, the API surfaces 15 operations — 2 DELETE, 4 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

REST Services 15

Custom REST API module, handler, and OAuth management

GET
/ords/rest/modules/
Oracle Database Get all REST modules
getRESTModules → 200401
POST
/ords/rest/modules/
Oracle Database Create a REST module
createRESTModule body → 201400401
PUT
/ords/rest/modules/{id}
Oracle Database Update a REST module
updateRESTModule 1 param body → 200401404
GET
/ords/rest/handlers/
Oracle Database Get all REST handlers
getRESTHandlers → 200401
POST
/ords/rest/handlers/
Oracle Database Create a REST handler
createRESTHandler body → 201401
DELETE
/ords/rest/handlers/{id}
Oracle Database Delete a REST handler
deleteRESTHandler 1 param → 200401404
GET
/ords/rest/clients/
Oracle Database Get all OAuth clients
getOAuthClients → 200401
POST
/ords/rest/clients/
Oracle Database Create an OAuth client
createOAuthClient body → 201401
PUT
/ords/rest/clients/{id}
Oracle Database Update an OAuth client
updateOAuthClient 1 param body → 200401404
POST
/ords/rest/privileges/
Oracle Database Create a REST privilege
createPrivilege body → 201401
POST
/ords/rest/roles/
Oracle Database Create a REST role
createRole body → 201401
POST
/ords/rest/autorest/
Oracle Database REST enable a database object
autoRESTEnableObject body → 201401
GET
/ords/properties/
Oracle Database Get ORDS properties
getORDSProperties → 200401
PUT
/ords/properties/{key}
Oracle Database Set an ORDS property
setORDSProperty 1 param body → 200401
DELETE
/ords/properties/{key}
Oracle Database Unset an ORDS property
unsetORDSProperty 1 param → 200401

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RESTModule (5 properties), CreateOAuthClientRequest (4 properties), CreatePrivilegeRequest (4 properties), CreateRESTModuleRequest (4 properties). Each schema is shown below with its type and property counts.

ORDSPropertyList
object
1 property
CreateRESTModuleRequest
object
4 properties 2 required
AutoRESTRequest
object
4 properties 2 required
Error
object
3 properties
RESTModuleList
object
1 property
CreateOAuthClientRequest
object
4 properties 2 required
ORDSPropertyValue
object
1 property
CreatePrivilegeRequest
object
4 properties 2 required
RESTHandlerList
object
1 property
OAuthClientList
object
1 property
RESTModule
object
5 properties
CreateRoleRequest
object
2 properties 1 required
CreateRESTHandlerRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-database-rest-services-api-openapi.yml Raw ↑

Other APIs Oracle Database publishes across the network.

Oracle Database API for MongoDB
Oracle Database JDBC
Oracle Call Interface (OCI)
Oracle SQL Developer REST API
Oracle Transactional Event Queues (TxEventQ)
Oracle Database APEX API
Oracle Database Autonomous Databases API
Oracle Database Backups API
Oracle Database Bulk Operations API
Oracle Database Collections API
Oracle Database Data Dictionary API
Oracle Database Data Guard API
Where this information came from

This is an independent, third-party profile of Oracle Database REST Services 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.