Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Monitoring → Update Alert

AI-generated

Overview

This node operation updates an existing alert in the Commanders Act Monitoring resource. It is useful for modifying alert settings or parameters for monitoring purposes within the Commanders Act platform. For example, a user can update alert thresholds or notification settings for a specific alert ID.

Use Case Examples

  1. Updating an alert's configuration by specifying the alert ID and providing the updated alert details in the request body.
  2. Modifying the status or parameters of an existing monitoring alert to better fit current monitoring needs.

Properties

Name Meaning
Alert ID The unique identifier of the alert to update. Required to specify which alert to modify.
Query Parameters Optional query parameters to customize the API request, such as filters, pagination, sorting, etc.
Request Body The JSON object containing the updated alert data to be sent in the request body for the update operation.

Output

JSON

  • json - The JSON response from the Commanders Act API after updating the alert, containing the updated alert details or status information.

Dependencies

  • Commanders Act API credentials (site ID and API token) are required for authentication.

Troubleshooting

  • Ensure the Alert ID is provided; otherwise, the node will throw an error indicating the Alert ID is required.
  • Verify that the API credentials (site ID and token) are correctly set and valid to avoid authentication errors.
  • Check the request body JSON format for correctness to prevent request failures.
  • If the API returns an error, the node will throw a NodeApiError with the message from the API; review the error message and stack trace for debugging.

Discussion