Oracle Cloud Infrastructure Documentation

Creating a Database API Gateway Configuration

    1. Open the navigation menu and select Developer Services.
    2. In the Database Tools section, select Database API Gateway Configurations.
    3. In the Database API Gateway Configurations page, click Create Configuration.
    4. In the Create Database API Gateway Configuration page, enter the following fields:
      • Name: Enter a user-friendly name to help easily identify this configuration.
      • Compartment: Choose a compartment where you have the required permissions to create the configuration.
      • ORDS RESTful service definition location: Select where the gateway gets the ORDS REST endpoint definitions (modules, templates, and handlers):

        • DATABASE: The REST definitions are stored in the database and are read from the database at runtime. ORDS must be installed in every database used by the connection pool, and the Database Tools connection must connect using an ORDS runtime database user.

          Use this option when you want each database to manage and store its own ORDS REST services.

          Note

          Database Actions is supported only when the definition location is DATABASE

        • CLOUD: The REST definitions are stored in OCI as part of the Database API Gateway (ORDS) service configuration. All REST resources (user-defined modules, templates and handlers, and user-enabled features such as REST-enabled SQL and REST APIs) are defined in the service configuration. ORDS does not need to be installed in the target databases, and all pool connections are treated as direct database connections.

          Use this option when you want to manage REST definitions centrally in OCI and keep the databases free of ORDS installation requirements.

      • Advanced Options - Tags: (Optional) Add one or more tags to the configuration. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you are not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
    5. Click Create.

  • Use the oci dbtools database-api-gateway-config create-database-api-gateway-config-default command and required parameters to create a Database API Gateway Configuration. 

    oci dbtools database-api-gateway-config create-database-api-gateway-config-default --compartment-id <compartment_ocid>
--display-name <display name> --metadata-source [database|cloud]

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

  • Use CreateDatabaseToolsDatabaseApiGatewayConfig to create 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.