This documentation is for WSO2 API Manager 2.0.0 View documentation for the latest release.
Page Comparison - Working with Endpoints (v.10 vs v.11) - API Manager 2.0.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: ✉️: HAPOALIMEVALDEV-65) recommended values for timeouts and suspend


To configure failover endpoints go to the edit view of the API and navigate to the implementImplement tab and click Failover under endpoint type.


Endpoint ConfigurationDescription
Endpoint Suspend State

If you want to configure the suspension of an Endpoint specifying error codes, maximum suspension time, suspension factors etc., you can use Endpoint Suspension State in Advanced Endpoint Configuration.

Error Codes: Error codes in the drop down list which need to make the endpoint suspension. If the selected error codes are received from the endpoint, the endpoint will be suspended. Specify the transport error codes where the Endpoint Suspension should be triggered. You can select single or error codes here.

Initial duration: The time duration for which the endpoint will be suspended, when one or more suspend error codes are received from it for the first time.


When creating (or updating) Failover endpoints through the Publisher UI (in the Implement tab), you need to go into this configuration box of each endpoint and specify a set of Error Codes for the endpoint to fail over on and take off the Initial Duration by setting its value to -1. 

Max duration: The maximum time duration for which the endpoint is suspended when suspend error codes are received from it.

Factor: The duration to suspend can vary from the first time suspension to the subsequent time. The factor value decides the suspense duration variance between subsequent suspensions.

Endpoint Timeout state

Configurations of retry, error codes and delays in terms of Endpoint timeout can be configured with Endpoint Timeout State in Advanced Endpoint Configuration.

Error Codes: A list of error codes. If these error codes are received from the endpoint, the request will be subjected to a timeout.

Retries Before Suspension: The number of re-tries in case of a timeout, caused by the above listed error codes.

Retry Delay: The delay between retries in milliseconds.

Connection Timeout

Duration and the Response Actions after a Connection Timeout can be configured here in Advanced Endpoint Configuration.

Action: Response Action to be performed after connection timeout. You can select from Never Timeout, Discard Message, Execute Fault Sequence. The default value is Execute Fault Sequence.

Duration: The time duration of Connection Timeout in milliseconds.


if you want to change the Endpoint Connection Timeout duration globally affecting all APIs, do the following.

  1. Open the <APIM_HOME>/repository/conf/ file. Change the value of the timeout as given below.

    Code Block
  2. Open the <ESB_HOME>/repository/conf/ file and change the socket timeout value.

    Code Block

Note that the global socket timeout value should be greater than both the connection timeout value synapse global timeout and any endpoint timeouts given for your API.

For more information about endpoints and how to add, edit or delete them, see the WSO2 ESB documentation.