If a user uses direct endpoints to run an API, and you want to stop the API usage for a certain period, you can deactivate the API. You can deactivate the APIs, that is, the REST and SOAP endpoints of published processes. If users invoke the deactivated API, a 503 Service Unavailable error is displayed.
To deactivate the APIs, perform the following steps:
1In Application Integration Console, click APIs on the left navigation bar.
2Select the Cloud Server or a Secure Agent to see the APIs.
3Select one or more APIs that you want to deactivate, and click Deactivate.
The Update API Status dialog box appears.
4To deactivate an API on the Cloud Server, click Deactivate to proceed.
The status of the API is updated to Inactive on the APIs page.
5To deactivate an API on the Secure Agent, perform one of the following steps:
- If the process runs only on the selected Secure Agent, click Deactivate to proceed.
- If the process runs on more than one Secure Agent in a group, perform one of the following steps:
▪ Click Deactivate only on the selected Secure Agent to proceed with the selected Secure Agent.
▪ Click Deactivate on all the Secure Agents in the group to proceed with the Secure Agent group.
The status of the API is updated to Inactive on the APIs page.
Application Integration also updates the API status on the Properties Detail dialog box of the published process as shown in the following image:
If the status of the API appears as Inactive on the Properties Detail dialog box, you must activate the API to make the API available for the user.
