{ "opencollection": "1.0.0", "info": { "name": "Oracle Integration Integration Instance API", "version": "20190131" }, "items": [ { "info": { "name": "integrationInstance", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all Integration Instances in a compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190131/integrationInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. Does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Life cycle state to query on." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order\nfor TIMECREATED is descending. Default order for DISPLAYNAME is\nascending. If no value is specified TIMECREATED is default.\n" } ] }, "docs": "Returns a list of Integration Instances.\n" }, { "info": { "name": "Creates a new Integration Instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Integration Instance.\n" }, { "info": { "name": "Get Integration Instance", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Gets a IntegrationInstance by identifier" }, { "info": { "name": "Update the Integration Instance identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Integration Instance." }, { "info": { "name": "Delete a provisioned Integration Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Deletes an Integration Instance resource by identifier." }, { "info": { "name": "Add Log Analytics LogGroup for given integration instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/addLogAnalyticsLogGroup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add LogGroup with specified ocid for Integration Instance to enable sending OIC Activity \nStream to OCI Logging Analytics.\n" }, { "info": { "name": "Enable Oracle Managed Custom Endpoint for integration instance\n", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/addOracleManagedCustomEndpoint", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Oracle Managed Custom Endpoint for given integration instance.\n" }, { "info": { "name": "Change the compartment for an integration instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the compartment for an integration instance\n" }, { "info": { "name": "Change an Integration instance network endpoint.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/changeNetworkEndpoint", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change an Integration instance network endpoint. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Create Integration instance private endpoint outbound connection.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/changePrivateEndpointOutboundConnection", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change private endpoint outbound connection for given Integration instance. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Disable Process Automation for given Integration Instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/disableProcessAutomation", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Disable Process Automation for given Integration Instance\n" }, { "info": { "name": "Enable Process Automation for given Integration Instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/enableProcessAutomation", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Enable Process Automation for given Integration Instance\n" }, { "info": { "name": "Extend Data Retention period for given Integration Instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/extendDataRetention", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Extend Data Retention period for given Integration Instance\n" }, { "info": { "name": "Failover of integration instance for the purpose of disaster recovery.\n", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/failover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Allows failover for disaster recovery. Called in the context of integration instance in that region.\nUpon calling the failover api in the region where given instance was created, \nthe intigration instance if primary will be switched to standby and crossRegion integration instance \nwill be switched to primary and vice-versa.\n" }, { "info": { "name": "Remove Log Analytics LogGroup for given integration instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/removeLogAnalyticsLogGroup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Removes Log Analytics logGroup, if enabled for given integrationInstance. Since only single LogGroup can be enabled\nfor integration instance, no additional details are required to be includes in the request.\n" }, { "info": { "name": "Remove Oracle Managed Custom Endpoint for integration instance.\n", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/removeOracleManagedCustomEndpoint", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Remove Oracle Managed Custom Endpoint for given integration instance that was previously enabled.\n" }, { "info": { "name": "Start an integration instance that was previously in an INACTIVE state", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Start an integration instance that was previously in an INACTIVE state\n" }, { "info": { "name": "Stop an integration instance that was previously in an ACTIVE state", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190131/integrationInstances/:integrationInstanceId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "integrationInstanceId", "value": "", "type": "path", "description": "Unique Integration Instance identifier." } ] }, "docs": "Stop an integration instance that was previously in an ACTIVE state\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190131/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "integrationInstanceId", "value": "", "type": "query", "description": "The Integration Instance identifier to use to filter results" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190131/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Get work request errors.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190131/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Get the errors of a work request." }, { "info": { "name": "Get work request logs.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190131/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Get the logs of a work request." } ] } ], "bundled": true }