Skip to content

9.7 Retry Delay parameter And check_catalog environment variables

Rathna edited this page May 26, 2026 · 1 revision

Input Parameter: retryDelay

The retryDelay parameter controls the pause between retry attempts for operations that may be temporarily inconsistent in API Manager.

Overview

  • Parameter: -retryDelay
  • Type: Integer
  • Unit: Milliseconds
  • Applies to: CLI runtime behavior for retry-capable API Manager operations
  • Default: Internal application default is used when not explicitly provided

Why use retryDelay?

In some environments, API Manager may briefly return transient errors right after create/update operations (for example, temporary “Unknown API” responses) if caching is enabled.
retryDelay helps by waiting between retries, improving reliability for these eventual-consistency windows.

Usage

CLI argument

./apim.sh api import -c api-config.json -retryDelay 3000

JSON configuration file example

{
  "retryDelay": 3000
}

3000 means a 3-second delay between retries. Recommended values

Start with:

  • 2000–5000 ms for most environments
  • Increase if transient consistency-related failures persist
  • Keep lower in stable/fast environments to reduce run time

Troubleshooting

If you see intermittent failures immediately after create/update actions:

  • Increase retryDelay gradually (for example, 2000 -> 3000 -> 5000).
  • Re-run the same command and confirm stability.
  • Use stage/environment-specific configuration if behavior differs by environment.

Notes

  • retryDelay is most relevant in distributed or high-latency API Manager setups.
  • Combine with your existing environment/stage property strategy so the effective value matches the target runtime.

check_catalog Environment variable

  • com.axway.apimanager.api.data.cache controls API data caching behavior in API Manager-related operations. If it is enabled, use the enviroment variable check_catalog=true which the virtualized api presence in api catalog before updating quota and applications.

Note

  • Avoid using Load Balancer if com.axway.apimanager.api.data.cache is enabled.

Clone this wiki locally