Activate an API before you publish to a portal so that the gateway endpoint is available
for developers and consumers to invoke the API.
Before you begin
You must have the Activate or Deactivate APIs functional privilege that is assigned to
perform this task.
About this task
You can activate an API in the Manage APIs page. Alternatively you can also activate the API from
the API Details page.
Procedure
- Open the menu options and select
APIs.
A list of available APIs appears.
- Select the API to open the API details page. Click
Activate.
- Click Yes in the confirmation dialog box.
The API is now activated. The consumers of this API can now use the Gateway endpoint. You can now
publish the API to the required destination and expose the API for consumption by the consumers.
You can modify API details or update the API, except the name and version of the API, when the
API is in the active state. Active APIs are replaced during deployment with zero downtime and do not
break ongoing requests. The updated APIs do not become effective for ongoing requests.
Note:
- When you update an active API if an error is seen, the API becomes inactive but the changes are
saved.
- When the API is activated, you can define the custom gateway endpoints. For more information
about gateway endpoints, see Gateway Endpoints.
- When the API is activated, you can enable the tracer. For more information about how to enable
the tracer and view the tracing details, see Debugging API.