1. Oracle Integration REST APIs for Managing Oracle Integration InstancesREST API for Managing Oracle Integration Classic (User-Managed)
  2. Quick Start

Quick Start

Set up your environment for managing Oracle Integration Classic instances with REST APIs by performing the following tasks.

Step 1: Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to access Oracle Integration Classic account. Specifically, you will need:

  • User name and password for your Oracle Integration Classic account.

  • The Service URL of your Oracle Integration Classic instance, which is listed in the welcome e-mail you received with your trial or purchased subscription.

Step 2: Install cURL

The examples within this document use the cURL command-line tool to demonstrate how to access the Oracle Integration Classic REST API.

To connect securely to the server, you must install a version of cURL that supports SSL and provides an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. For more information about:

The following procedure demonstrates how to install cURL on a Windows 64-bit system.

  1. In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.

  2. On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.

  3. Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the ca-bundle.crt SSL CA certificate bundle in the folder where you installed cURL.

  4. Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate bundle. For example:

    C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt

You are now ready to send requests to the Oracle Integration Classic REST API using cURL.

Step 3: Get the health of your service instance

Use a cURL command such as the following to monitor the health of your service instance. Change example.com to the host in your Service URL as described in Send Requests. 

curl -i -X GET -u username:Password1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url.com/paas/api/v1.1/instancemgmt/{domainName}/services/IntegrationCloud/instances/{serviceName}/healthcheck

where, ExampleIdentityDomain is the identity domain name of the service, used for authentication. See Send Requests.