Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • Related Documents
  • Conventions
• Oracle REST Data Services Installation Checklist
  • System Requirements
    • GraalVM Configuration
  • Supported Java EE Application Servers
  • Deploying ORDS to a Kubernetes Cluster with Oracle Container Engine (OKE)
  • Supported Oracle APEX Versions
  • ORDS Installer Privileges Script
  • Privileges Granted to the Oracle REST Data Services Users
  • About the Database Users Used by Oracle REST Data Services
  • About Command-Line Interface
  • About Online Help
• Installing and Configuring Oracle REST Data Services
  • Installing Oracle REST Data Services
    • Downloading ORDS
    • Setting Up the Configuration Folder Structure
      • Specifying the New ORDS Configuration Folder
    • Interactive Command-Line Interface Installation
      • Auto Installation of ORDS
        • Scenario 1: New ORDS Configuration and ORDS Installation
        • Scenario 2: Single Database Pool (Default Pool)
        • Scenario 3: Multiple Database Pools
        • Scenario 4: Add or Update Configuration Only
        • Scenario 5: Install or Upgrade ORDS in Database Only
          • Entering a Number to Select the Database Pool
        • Creating an Additional Database Pool
          • Entering the Database Pool Name
          • Entering a Number to Select the TNS Net Service Name to Use or Specify the Database Connection
          • Entering a Number to Select the Database Connection
        • Multiple Options for Database Pool and Standalone Configuration
          • Multiple Options with Default Values
          • Standalone Configuration
        • Setup Bequeath Connection for Interactive Install
    • Non-Interactive Command-Line Interface Installation (Silent)
      • Non-interactive (Silent) ORDS Operations Using the Bequeath Connection
      • Understanding Command Options for Command-Line Interface Installation
      • Using Input Redirection
    • Configuring ORDS to use with APEX
  • Repairing the Oracle REST Data Services Installation
    • Command Options for Repair CLI
  • Upgrading Oracle REST Data Services
    • Migrate Configuration and Upgrade from ORDS 21.4.x or Earlier Releases
      • Interactive Upgrade
      • Silent Upgrade
      • Upgrading the Multiple Database Pools
  • Uninstalling Oracle REST Data Services
    • Interactive Uninstall CLI
      • Entering a Number to Select the Database Pool
      • Entering a Number to Select the Database Connection Type
      • Entering the Database Host Name
      • Entering the Database Listener Port
      • Entering the Database Service Name
      • Entering the TNS Location
      • Entering a Number to Select the TNS Network Alias
      • Entering the Custom Database URL
      • Entering the Administrator Username
      • Entering the Database Password for SYS AS SYSDBA
      • Entering an Option for Uninstalling ORDS
    • Non-Interactive Uninstall CLI
      • Using Input Redirection
      • Command options for Uninstall CLIConfigure the Global MCP JWT Profile
  • Updating the Configuration Settings
• Configuring Model Context Protocol (MCP)
  • About ORDS Model Context Protocol Configuration
  • ORDS MCP Configuration Settings
  • Enable the ORDS MCP Endpoint
  • Configure the Global MCP JWT Profile
  • Configure MCP Databases in Scope Mode
  • Configure MCP Databases in Role Mode
  • Configure Schema-Based Reports
  • Verify MCP Configuration
  • Troubleshoot MCP Configuration
• ORDS Configuration and Deployment Strategies
  • Deploying ORDS with Local Configuration
    • About the Request URL
    • Configuring Additional Databases
    • Advanced Routing
    • Routing Based on the Request Path
    • Routing Based on the Request Hostname
  • Deploying ORDS with the OCI Database API Gateway Configuration Service
    • ORDS RESTful Service Definition Locations
    • Configuration Settings
    • OCI Database API Gateway Configuration Settings
    • OCI Database API Gateway Configuration Global Settings
    • Advanced ORDS Global Settings
    • OCI Database API Gateway Configuration Pool Settings
    • Advanced ORDS Pool Settings
    • Auto API Specifications
      • API Specifications
    • OCI Security
    • Deploying ORDS with the OCI Database API Gateway Configuration service
  • Deploying ORDS with Central Configuration Server
    • OpenAPI Specification
    • Database Mapping
      • Request Host Method
      • Header Method
      • Direct URL Specification
    • Global Configuration Settings
    • Database Pool Configuration Settings
      • Using eTag
      • Adding Credentials to an Instance Wallet
    • Security
      • Demonstration to Create an Entry of a Wallet for OAuth2.0 Authentication
    • Starting ORDS in a Central Configuration Deployment
      • Satisfying the HTTPS Requests
  • Deploying ORDS with ETCD
    • Prerequisites
    • Database mapping
    • Configuration Settings
    • Starting ORDS with ETCD
• Overview of Schema Level Configuration Override
  • Features of Schema Level Configuration Override
  • Overridable Configuration Properties
  • Use Cases
  • Scope and Visibility Matrix
• Miscellaneous Configuration Options of Oracle REST Data Services
  • Using the REST Enabled SQL Service with MySQL Database
    • Understanding the Database Credentials Source Setting
    • Configuring a Pool for MySQL Database
      • Configuring ORDS for Supported Containers
        • ORDS Running in Standalone Mode
        • ORDS Deployed in Apache Tomcat
        • ORDS Deployed in Weblogic Server
  • Configuring Jetty in ORDS Standalone Mode
    • Using Java System Properties
    • Java System Properties
    • Using Jetty XML Configuration Files
  • Support for Oracle RAC Fast Connection Failover
  • Configuring ORDS with Kerberos Setup
  • Authorizing Oracle REST Data Services to Access Oracle Data Guard Protected Users
  • Configuring REST-Enabled SQL Service Settings
  • Configuring ICAP Server Integration for Virus Scan
  • Configuring the Custom Error Pages
  • Managing ORDS Administrator Privilege
    • Provisioning ORDS_ADMINISTRATOR_ROLE to a User
    • Unprovisioning ORDS_ADMINISTRATOR_ROLE from a User
  • Managing ORDS Runtime Privilege
    • Provisioning ORDS_RUNTIME_ROLE to a User
    • Unprovisioning ORDS_RUNTIME_ROLE from a User
  • Using OAuth2 in Non-HTTPS Environments
  • ORDS Performance Considerations
    • Configuring the Maximum Number of Rows Returned from a Query
    • Configuring ORDS Metadata Cache
  • Configuring ORDS to Connect with OCI Database Tools Connections
    • Using Instance Principal Authentication
    • Using OCI Profile Authentication
• Deploying and Monitoring Oracle REST Data Services
  • Deploying Oracle REST Data Services
    • Serve Commands for Running in Standalone Mode
      • Non-Interactive Serve CLI
      • Serve Command Options
      • Ending an ORDS Process
      • Converting a Private Key to DER (Linux and Unix)
      • Configuring a Doc Root for Non-APEX Static Resources
    • Oracle WebLogic Server
      • About Oracle WebLogic Server
      • Configuring Oracle APEX Images
      • Launching the Administration Server Console
      • Deploying ORDS on Oracle WebLogic Server
      • Configuring WebLogic to Handle HTTP Basic Challenges Correctly
      • Verifying the State and Health of ords and i
    • Apache Tomcat
      • About Apache Tomcat
      • Configuring Oracle APEX Images
      • Deploying ORDS on Apache Tomcat
    • Oracle Cloud Infrastructure
      • About Oracle Cloud Infrastructure
      • Configuring ORDS for High Availability on Oracle Cloud Infrastructure
      • Advantages of Deploying ORDS with High Availability on Oracle Cloud Infrastructure
  • Monitoring Oracle REST Data Services
    • Using the Instance API
      • Enabling the ORDS Instance API
      • Authorization for Using the ORDS Instance API
      • API Document
    • Using OpenTelemetry with Oracle REST Data Services
    • ORDS CLI Commands for Managing Pools Using JMX
    • Using OCI Monitoring Service with Oracle REST Data Services
      • ords-metrics Utility
      • Configuring ORDS to Send Metrics to OCI Monitoring Service
      • Enable JMX Metrics
      • Configuring OCI Alarms
    • Using OCI Logging Service with Oracle REST Data Services
      • Configure Java Logging in ORDS
      • Create an agent configuration
• Using the Multitenant Architecture with Oracle REST Data Services
  • Setting Up ORDS in a CDB Environment
    • Installation Enabling Multiple Releases
      • Command Line Installation
      • Interactive Installation
      • Silent Installation
    • Upgrading Oracle REST Data Services in a CDB Environment
      • Migrating Oracle REST Data Services in the CDB to Enable Multiple Releases
    • Uninstalling Oracle REST Data Services in a CDB Environment
  • Setting Up ORDS in an Application Container
    • Prerequisites for Creating ORDS in an Application Container
      • Creating an Application Root Container
    • Installing ORDS in the Application Root Container
    • Creating an Application Seed
    • Creating an Application PDB from the Application Seed
    • Configuring the PLSQL Gateway for APEX
    • ORDS Configuration Files Setup
      • Specifying the ORDS Configuration Folder
      • Creating the ORDS Configuration Files for the Application Root Container
    • Running ORDS
    • Upgrading ORDS in the Application Container
    • Uninstalling ORDS from the Application Container
    • Verifying ORDS in the Application Container
  • Making All PDBs Addressable by Oracle REST Data Services (Pluggable Mapping)
• Installing and Configuring Customer Managed ORDS on Autonomous Database
  • About Customer Managed Oracle REST Data Services on Autonomous Database
  • Preinstallation Tasks
    • Downloading the Autonomous AI Database Wallet
    • Oracle APEX Static Resources
  • ORDS Command-Line Interface for Customer Managed ORDS
    • Interactive Install for ADB Command Line Interface
      • Customer Managed ORDS Command Options
      • Interactive Installation Prompts
        • Entering a Number to Select the Database Pool
        • Entering the Database Pool Name
        • Entering the Autonomous Database Wallet Path
        • Enter a Number to Select the TNS Network Alias
        • Enter the Administrator Username
        • Enter the Database Password for ADMIN
        • Entering the ORDS Runtime Database Username
        • Entering the Database Password for ORDS_PUBLIC_USER2
        • Entering the PL/SQL Gateway Database Username
        • Enter the Database Password for ORDS_PLSQL_GATEWAY2
        • Entering a Number to Select and Enable Additional Feature
        • Enter a Number to Configure and Start ORDS
        • Entering a Number to Use HTTP or HTTPS Protocol
          • Entering the HTTP Port
        • Entering the HTTPS Port
        • Entering a Number to Select the Certificate Type
        • HTTPS Protocol and Use Self-Signed Certificate
        • HTTPS Protocol and Use my SSL Certificate
          • Entering the Path for the SSL Certificate
          • Entering the Path for the SSL Certificate’s Private Key
        • Entering the APEX Static Resources Location
    • Silent Installation of ADB on Command-Line Interface
      • Using Input Redirection
• Enabling and Configuring the Oracle Database API for MongoDB
  • Getting Started
  • Requirements
  • Configurable Settings for MongoDB
  • Examples
  • Accessing the Connection Pools
  • Logging MongoDB API Access
• Migration of Legacy Configuration
  • Migrating From Legacy Configurations Using the CLI Installation
  • Migrating URL Mapping
• Setting-up a PL/SQL Gateway User
  • Configuring a PL/SQL Gateway User for APEX
  • Configuring a PL/SQL Gateway User to Serve PL/SQL Gateway Requests Directly
    • Installing/Upgrading the PL/SQL Gateway User
    • Configuring the PL/SQL Gateway User
• Non-Interactive ORDS CLI Commands Examples
  • Non-Interactive Install/Upgrade
  • Non-Interactive Install/Upgrade (create a proxied PLSQL Gateway User)
  • Non-Interactive Install/Upgrade (specify PLSQL Gateway User and not using RESTful Services)
  • Non-Interactive Install/Upgrade (disable a configured PLSQL Gateway)
  • Non-Interactive Uninstall ORDS
  • config CLI Examples
  • Resolving 570 Server Error Response Code
• ORDS Legacy Commands and New ORDS CLI Commands
• About the Oracle REST Data Services Configuration Files
  • Understanding the Configuration Folder Structure
  • Understanding the Configuration File Format
  • Understanding the Configurable Settings
• ORDS Central Configuration OpenAPI