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 Integration Instance API

The integrationInstance API from Oracle — 19 operation(s) for integrationinstance.

Oracle Integration Instance API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 22 operations across 19 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 20190131.

Requests are made against a single base URL, https://127.0.0.1/20190131.

22 operations 19 paths 25 schemas 1 DELETE6 GET14 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20190131
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 22

Across 19 paths, the API surfaces 22 operations — 1 DELETE, 6 GET, 14 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

integrationInstance 22
GET
/integrationInstances
Gets a list of all Integration Instances in a compartment
ListIntegrationInstances 8 params → 200400401404429500default
POST
/integrationInstances
Creates a new Integration Instance
CreateIntegrationInstance 2 params body → 202400401404409429500default
DELETE
/integrationInstances/{integrationInstanceId}
Delete a provisioned Integration Instance
DeleteIntegrationInstance 3 params → 202400401404412429500default
GET
/integrationInstances/{integrationInstanceId}
Get Integration Instance
GetIntegrationInstance 2 params → 200400401404429500default
PUT
/integrationInstances/{integrationInstanceId}
Update the Integration Instance identified by the id
UpdateIntegrationInstance 3 params body → 202400401404412429500default
POST
/integrationInstances/{integrationInstanceId}/actions/addLogAnalyticsLogGroup
Add Log Analytics LogGroup for given integration instance
AddLogAnalyticsLogGroup 4 params body → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/addOracleManagedCustomEndpoint
Enable Oracle Managed Custom Endpoint for integration instance
AddOracleManagedCustomEndpoint 4 params body → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/changeCompartment
Change the compartment for an integration instance
ChangeIntegrationInstanceCompartment 4 params body → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/changeNetworkEndpoint
Change an Integration instance network endpoint.
ChangeIntegrationInstanceNetworkEndpoint 4 params body → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/changePrivateEndpointOutboundConnection
Create Integration instance private endpoint outbound connection.
ChangePrivateEndpointOutboundConnection 4 params body → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/disableProcessAutomation
Disable Process Automation for given Integration Instance
DisableProcessAutomation 4 params → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/enableProcessAutomation
Enable Process Automation for given Integration Instance
EnableProcessAutomation 4 params → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/extendDataRetention
Extend Data Retention period for given Integration Instance
ExtendDataRetention 4 params body → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/failover
Failover of integration instance for the purpose of disaster recovery.
DisasterRecoveryFailover 4 params → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/removeLogAnalyticsLogGroup
Remove Log Analytics LogGroup for given integration instance
RemoveLogAnalyticsLogGroup 4 params → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/removeOracleManagedCustomEndpoint
Remove Oracle Managed Custom Endpoint for integration instance.
RemoveOracleManagedCustomEndpoint 4 params → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/start
Start an integration instance that was previously in an INACTIVE state
StartIntegrationInstance 4 params → 202400401404409412429500
POST
/integrationInstances/{integrationInstanceId}/actions/stop
Stop an integration instance that was previously in an ACTIVE state
StopIntegrationInstance 4 params → 202400401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 5 params → 200400401404429500default
GET
/workRequests/{workRequestId}
Get Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Get work request errors.
ListWorkRequestErrors 5 params → 200401404429500default
GET
/workRequests/{workRequestId}/logs
Get work request logs.
ListWorkRequestLogs 5 params → 200401404429500default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are IntegrationInstance (31 properties), IntegrationInstanceSummary (28 properties), CreateIntegrationInstanceDetails (18 properties), UpdateIntegrationInstanceDetails (11 properties). Each schema is shown below with its type and property counts.

IntegrationInstance
object
Description of Integration Instance.
31 properties 7 required
CreateIntegrationInstanceDetails
object
The information about new IntegrationInstance. Some properties may not be applicable to specific integration types, see [Differences in Instance Management](ht…
18 properties 5 required
AddOracleManagedCustomEndpointDetails
object
Details for enabling Oracle Managed custom endpoint
3 properties 1 required
IntegrationInstanceSummary
object
Summary of the Integration Instance.
28 properties 7 required
WorkRequestError
object
Errors related to a specific work request.
3 properties 3 required
WorkRequestSummary
object
A description of work request status.
9 properties 7 required
WorkRequest
object
A description of work request status.
9 properties 7 required
ChangeIntegrationInstanceCompartmentDetails
object
The information to be updated.
1 property
CreateCustomEndpointDetails
object
Details for a custom endpoint for the integration instance (update).
2 properties 1 required
UpdateCustomEndpointDetails
object
Details for a custom endpoint for the integration instance (update).
2 properties 1 required
ExtendDataRetentionDetails
object
Details for extending data retention for given integration instance
1 property 1 required
OutboundConnection
object
Base representation for Outbound Connection (Reverse Connection).
1 property 1 required
AttachmentDetails
object
Description of an attachments for this instance
5 properties 5 required
DisasterRecoveryDetails
object
Disaster recovery details for the integration instance created in the region.
3 properties 3 required
IdcsInfoDetails
object
Information for IDCS access
5 properties 5 required
AddLogAnalyticsLogGroupDetails
object
Input payload to ADD Log Analytics Log Group for given IntegrationInstance. Some actions may not be applicable to specific integration types.
1 property 1 required
Error
object
Error Information.
2 properties 2 required
CustomEndpointDetails
object
Details for a custom endpoint for the integration instance.
7 properties 1 required
ChangePrivateEndpointOutboundConnectionDetails
object
Input payload to ADD/REMOVE Private Endpoint Outbound Connection for given IntegrationInstance. Some actions may not be applicable to specific integration type…
1 property
NetworkEndpointDetails
object
Base representation of a network endpoint.
1 property 1 required
WorkRequestLogEntry
object
Log entries related to a specific work request.
2 properties 2 required
CrossRegionIntegrationInstanceDetails
object
Details of integration instance created in cross region for disaster recovery.
4 properties
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties 3 required
ChangeIntegrationInstanceNetworkEndpointDetails
object
Input payload to update an Integration instance endpoint details. An empty payload will clear out any existing configuration. Some actions may not be applicabl…
1 property
UpdateIntegrationInstanceDetails
object
The information to be updated. Some properties may not be applicable to specific integration types, see [Differences in Instance Management](https://www.oracle…
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-integrationinstance-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Integration Instance 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.