Caldera REST API V2: New port for the Caldera RIP service

This troubleshooting guide is designed to help experienced REST API users address potential issues following a recent change to the Caldera RIP service fixed port, which is now 45344

If you are using the default configuration, no changes are expected as Caldera REST API V2 will handle that change.

However, if an unexpected behavior occurs, you might need to update the port manually to ensure the correct functionality of the service.

Updating the Port for the Caldera RIP Service

• In API clients or scripts:
  • Update the API base URL to include the new port:
    
    

    Now (V2 or later)	Previously (V1.2.0 or earlier)
    port: default: '45344'	port: default: '45343'

• In Postman/Swagger:
  • Open your API project in Postman or Swagger.
  • Locate the Caldera RIP service request.
  • Update the port in the request URL to 45344
  • Test the connection by sending a simple GET request, to check if the server responds correctly.

Possible Related Issues

Although the main issue that users may encounter is the discrepancy in ports, other potential issues can arise after configuration changes. Here are some common challenges and their potential solutions:

• Connection Refused or Timeouts:
  • Cause: The client might still be pointing to the old port (45343), or network rules may block traffic on the new port 45344.
  • Solution: Double-check all configurations to ensure that the Caldera RIP service uses port 45344. Ensure firewalls or security settings allow traffic through the port.
• Permission Denied (403 Forbidden):
  • Cause: The Caldera RIP service may deny access if proper roles or permissions are not assigned to the requesting entity.
    The 403 response is often returned, for example, because the remote RIP service doesn't have a CalderaCare license or subscription.
  • Solution: Verify that the credentials, licenses, roles, and Caldera RIP service rules are assigned to the user or service making the request.
• Authentication Failure (401 Unauthorized):
  • Cause: Invalid or missing authentication tokens used when interacting with the Caldera RIP service.
  • Solution: Confirm that valid tokens are being sent. If expired, refresh or regenerate them.
• Misconfigured Environments:
  • Cause: Different environments (e.g., development, staging, production) may have inconsistent port configurations.
  • Solution: Ensure that all environments use the port 45344 for the Caldera RIP service consistently.

Testing and Debugging Using Available Tools

When verifying the Caldera RIP service configuration, testing tools can help identify and resolve issues efficiently:

• Postman: Update Caldera RIP service-related request URLs with port 45344 and test requests for successful responses.
• Swagger: Adjust the Caldera RIP service URLs in Swagger to include the correct port and send test requests to confirm connectivity.
• Caldera's Testing Interface: Use this tool to view detailed logs of failed Caldera RIP service requests and identify specific errors, such as connectivity issues or permission failures.

For more information, please refer to the dedicated documentation.

Conclusion

If issues persist despite following these steps, we recommend revisiting your configurations and testing tools to ensure all updates are correctly applied.

For persistent or unexplained problems, you may contact support for additional assistance.