FAQ & Troubleshooting

Answers to frequently asked questions and troubleshooting tips.

Frequently Asked Questions

1. How do I authenticate API requests?

• Use the x-api-key header with your API key in all requests.

2. What should I do if I receive a 401 Unauthorized error?

• Ensure that your API key is valid and included in the x-api-key header.

3. How can I retrieve all alarms?

• Use the GET /alarm/all endpoint. Refer to the User Guide for detailed examples.

4. What is the purpose of the .env file?

• The .env file contains environment-specific configurations, such as the APP_NAME and other settings required for the service to function correctly.

5. How do I handle rate limiting?

• If you encounter rate limiting, reduce the frequency of your requests and ensure you stay within the allowed limit of 10,000 requests per minute per IP.

6. What should I do if I encounter a 500 Internal Server Error?

• Check the server logs for more details and ensure that all required configurations and dependencies are correctly set up.