Activating an API

Edit online

About this task

You must first activate the API before publishing it to a portal so that the gateway endpoint is available for developers and consumers to invoke the API.

You must have the Activate/Deactivate APIs functional privilege assigned to perform this task. You can activate an API in the Manage APIs page. Alternatively you can also activate the API from the API Details page.

To activate an API

Procedure

  1. Click APIs in the title navigation bar.
    A list of available APIs appears.
  2. Do one of the following:
    • Click the toggle button, in the corresponding column of the API to be activated, to change the status to to activate the API.
    • Select the API to open the API details page. Click Activate.
  3. Click Yes in the confirmation dialog box.
    The API is now activated. The Gateway endpoint is now available, which can be used by the consumers of this API. 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:
    • If there is an error while saving after updating an active API, the API becomes inactive but the changes are saved.
    • Once the API is activated, you can define the custom gateway endpoints. For more information about gateway endpoints, see Gateway Endpoints.
    • Once 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 APIDebugging API.