Get help with API management

Kathyana Queeman

Updated May 07, 2024 19:34

For specific questions or issues related to API management, create a support ticket or use Celigo platform integrator.io’s community.

Table 1. Error codes

Error code	Message	Possible cause
401	Unauthorized	The API key or any other security method used to validate the API is incorrect.
404	No context-path matches the request URI	The context path is different The API hasn't started
502	Bad Gateway	The HTTP method is different The Keep-Alive (Idle timeout) settings are causing an error. See Troubleshooting common errors for more.
503	Bad Entrypoint	The entrypoint is not available. This often occurs due to errors with Health Check. See Troubleshooting common errors for more.
504	Gateway timeout	API is taking longer than the gateway timeout set in the API manager API backend service needs to work in an async pattern.

Troubleshooting common errors

There are several known errors that are easy to resolve. Below are a few known errors and resolutions.

502s and Keep-Alive

The Keep-Alive endpoint setting is enabled by default. The Keep-Alive timeout is also known as the Idle Timeout in the endpoint configuration. This setting uses a persistent HTTP connection to send and receive multiple HTTP requests and responses.

Problem

Random or intermittent 502 responses were received from the backend.

Root cause

If the Keep-Alive on the gateway side is higher than the one on the backend or intermediate layers, the connection could close on the backend while the gateway thinks it's open and usable.

Resolution

Ensure that your Keep-Alive (Idle Timeout) settings follow the recommended guidelines.

503s and Health Check

Sometimes, the Health Check feature causes a 503 (bad entrypoint) error.

Problem

When calling an API, it initially returns 200 responses, but after a few minutes, subsequent API calls begin returning 503 responses.

Stopping and restarting the API repeats the cycle, starting with responses of 200 and then once again returning 503 errors.

Root cause

When Health Check is configured in endpoints, the gateway periodically attempts to check whether the backend is responsive for a specific endpoint.

After 3 consecutive failures, the gateway will remove the endpoint from its endpoints pool, leading to 503 errors.

Resolution

Check the Health Check configuration and Dashboard for any errors or fix the Health Check configuration settings for the API.

Creating an API

Authentication errors

Ensure you use the correct authentication method (e.g., API key, token) and that your credentials are accurate.
Double-check the authentication configuration within the API, including client IDs, secrets, and scopes.

Endpoint configuration

Verify that the API endpoint URL is correct and accessible.
Check for any firewall or network restrictions that might prevent access to the API endpoint.
Ensure that the endpoint supports the HTTP methods (GET, POST, PUT, DELETE, etc.) you are trying to use.

Updating an API

Versioning

If you update an existing API, update the version number and endpoint URLs accordingly.
Check if the changes made to the API are compatible with the existing client applications that consume the API.

Data validation

Validate all data inputs and outputs to ensure they conform to the API specifications.
Check for any unexpected data transformations or validations that might be causing issues.

Error handling

Implement proper error-handling mechanisms in your API to provide meaningful error messages to clients.
Monitor error logs and metrics to identify and troubleshoot issues effectively.

Deleting an API

Dependencies

Check for dependencies on the API you are trying to delete. Other services or applications might rely on it.
Ensure that no active integrations or flows within integrator.io use the API you intend to delete.

Permissions

Verify that you have the necessary permissions to delete the API. Some APIs may require elevated privileges for deletion.
Contact Celigo Support to grant the appropriate permissions if you encounter permission issues.

Backup and recovery

Before deleting an API, ensure you have a backup of its configuration and data. This backup can be crucial in case of accidental deletions or data loss.