Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Monitoring → Create Alert

AI-generated

Overview

This node interacts with the Commanders Act API to create an alert within the Monitoring resource. It is useful for users who want to programmatically set up alerts for monitoring purposes in their Commanders Act environment. For example, a user can automate the creation of alerts based on specific monitoring criteria to stay informed about important events or anomalies.

Use Case Examples

  1. Creating an alert to monitor system health or specific events in Commanders Act.
  2. Automating alert creation as part of a larger workflow to ensure timely notifications.

Properties

Name Meaning
Query Parameters Optional parameters to customize the API request, such as filters, pagination, sorting, and other query options relevant to the alert creation context.
Request Body JSON object representing the alert details to be created, including all necessary fields as required by the Commanders Act API for alert creation.

Output

JSON

  • id - The unique identifier of the created alert.
  • name - The name of the created alert.
  • status - The status of the created alert.
  • createdAt - Timestamp when the alert was created.
  • updatedAt - Timestamp when the alert was last updated.

Dependencies

  • Commanders Act API with an API token credential

Troubleshooting

  • Ensure that the API credentials (site ID and API token) are correctly configured and valid, as missing or invalid credentials will cause authentication errors.
  • Verify that the required fields in the request body are correctly formatted JSON and include all mandatory alert details, otherwise the API may reject the request.
  • Check that the alert ID is not required for creation (it is used for update/delete operations), and that the operation is correctly set to 'Create Alert'.
  • If the API returns errors, inspect the error message for details and ensure the endpoint URL is correctly constructed with the site ID and query parameters.

Discussion