Filters API Documentation

This document provides detailed information about the filters-related endpoints in the API.

Endpoints

1. Get Alarm Config Dashboards

• Endpoint: GET /filter/dashboards
• Description: Retrieves all unique dashboards from the alarm configuration.
• Request Parameters: None
• Response:
• 200 OK: Returns a JSON array of unique dashboards.
• 500 Internal Server Error: Error occurred while fetching dashboards.

2. Get Alarm Config Services

• Endpoint: GET /filter/alarmservices
• Description: Retrieves all unique services from the alarm configuration.
• Request Parameters: None
• Response:
• 200 OK: Returns a JSON array of unique services.
• 500 Internal Server Error: Error occurred while fetching services.

3. Get Alarm Config Types

• Endpoint: GET /filter/alarmtypes
• Description: Retrieves all unique types from the alarm configuration.
• Request Parameters: None
• Response:
• 200 OK: Returns a JSON array of unique types.
• 500 Internal Server Error: Error occurred while fetching types.

Notes

• Ensure the x-api-key header is included in all requests for authentication.
• Refer to the User Guide for additional context on using the API.