Monitor

Back Next

APIs

The APIs page shows a list of

APIs

of published processes that use the REST/SOAP binding, along with the REST and SOAP endpoints and their status. Use the

APIs

page to activate or deactivate the APIs of published processes.

You can activate or deactivate the APIs, that is, the REST and SOAP endpoints from the

APIs

page. With this option, you don't have to unpublish and republish a process to deactivate and activate the API. When you publish a process from

Application Integration

for the first time, the API is activated and displayed on the

APIs

page in

Application Integration Console

. Later, when you activate or deactivate the API from the

APIs

page,

Application Integration

also updates the API status in the

Properties Detail

dialog box of the published process. Republishing a process with an inactive API status does not activate the API. You must activate it from the

APIs

page. If you unpublish the process from

Application Integration

, the API is removed from the

APIs

page.

Activation or deactivation does not apply to scheduled processes and subprocesses. Activation or deactivation of a scheduled process API does not affect schedules. If a process contains a subprocess, and you deactivate the API of the parent process, the subprocess inside it still runs.

Example

Consider a bank that offers fund transfers on its web portal through APIs developed using Application Integration. The bank uses an Oracle database to store transaction information for future audits and monitoring.

During database maintenance, the bank wants to temporarily stop transactions to avoid potential issues with incoming requests.

In this case, the bank can filter and find all APIs that enable fund transfers and deactivate them. If customers invoke the deactivated APIs during the downtime, they will see a

503 Service Unavailable

or an equivalent message. After maintenance is complete, the APIs can be activated to resume fund transfers.

Viewing APIs

Deactivating an API

Activating an API

Download Guide

Watch

Comments

Cloud Application Integration Homepage

Free Trial

Communities

Knowledge Base