Oracle Cloud Infrastructure Documentation

Update the Global Settings for a Database API Gateway Configuration

    1. In the Database API gateway configurations page, select the name of the configuration you want to update.
    2. Expand the Actions menu and select Edit Global Settings.
    3. In the Edit Global Settings page, update the required settings as needed:

      • Pool route: Select how incoming HTTP requests are routed to pools.

        • Path based: The poolRouteValue is provided in the request path. This is the default value (PATH).

        • Header based: The poolRouteValue is provided in a request header.

          • Pool routing header: Specifies the request header name that provides the pool route value when the Pool route value is HEADER.
      • Document root: Required only if the ORDS instances host static content such as APEX images. APEX images are found using the Document root and the APEX image context path (default /i ).

        • If not set, then ORDS does not provide any static resources from disk.

        • Oracle recommends using the Oracle CDN for APEX images.

      • Enable Database API feature: Enables the ORDS Database API (a database management and monitoring REST API). Database Actions requires this feature.

      • Enable HTTPS access: Specify the HTTPS port.

        • 0 disables access. Default is 8443.

        • Range 1–65535. Ports below 1024 require elevated (root) privileges and are generally discouraged. Oracle recommends using non-privileged ports (1024–65535).
        • If you set an HTTPS port without providing certificate paths, ORDS uses a self-signed certificate. The self-signed certificate is persisted on the file system based on the ORDS home directory.

        This self signed cert would be persisted on the file system based on the ORDS Home.

      • Enable HTTP access: Specify the HTTP port.

        • 0 disables access. Default is 0.

        • Range 1–65535. Ports below 1024 require elevated (root) privileges and are generally discouraged. Oracle recommends using non-privileged ports (1024–65535).

        • These settings can be overriden using the ORDS command line.

      • Certificate bundle - Use self-signed certifcate:

        Choose whether to use a self-signed certificate (testing only) or provide certificate details to support HTTPS.

        • SSL public certificate path: Path to the public certificate.
        • SSL public certificate format: PEM is the only valid format.
        • Private key path: Path to the certificate key.
        • SSL private key format: DER or PEM.
    4. For Advanced Properties, you can use all global settings defined in Advanced ORDS Global Settings, except:
      • Global settings that are already defined in the properties, and
      • Database-related settings (db.username, db.password, db.*)

  • Use the oci dbtools-runtime database-api-gateway-config-global update default command to update a Database API Gateway Configuration. 

    oci dbtools-runtime database-api-gateway-config-global update default --database-api-gateway-config-id <config_ocid>
--global-key <global-key> [--pool-route <value>] [--pool-routing-header <value>] [--database-api-status <value>] [--http-port <port>]
[--https-port <port>] [--certificate-bundle <cert-bundle>] [--document-root <path>] [--advanced-properties <json>] [--if-match <etag>] [--force]
 
oci dbtools-runtime database-api-gateway-config-global update certificate-bundle-file-name --database-api-gateway-config-id <config_ocid>
--global-key <global-key> [--pool-route <value>] [--pool-routing-header <value>] [--database-api-status <value>] [--http-port <port>] 
[--https-port <port>] [--document-root <path>] [--advanced-properties <json>] [--certificate-bundle-certificate-public <public-cert>] 
[--certificate-bundle-certificate-private-key <private-key>] [--if-match <etag>] [--force] 

oci dbtools-runtime database-api-gateway-config-global update certificate-bundle-self-signed --database-api-gateway-config-id <config_ocid>
--global-key <global-key> [--pool-route <value>] [--pool-routing-header <value>] [--database-api-status <value>] [--http-port <port>] 
[--https-port <port>] [--document-root <path>] [--advanced-properties] [--if-match <etag>] [--force]

    For a complete list of parameters and values for CLI commands, see the Command Line Interface (CLI).

  • Use the UpdateDatabaseToolsDatabaseApiGatewayConfigGlobal API to update a Database API Gateway Configuration.

    For information about using the API and signing requests, see REST API and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.