Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically providing access to various resources and operations within the platform. For the Monitoring resource and the Get Alert operation, it retrieves detailed information about a specific alert configured in the Commanders Act monitoring system.

Use cases include:

  • Fetching details of a particular alert to monitor its status or configuration.
  • Integrating alert data into workflows for automated incident handling or reporting.
  • Auditing alert configurations programmatically.

Example: You want to retrieve the current state and metadata of an alert identified by its Alert ID to decide if further action is needed in your automation.

Properties

Name Meaning
Alert ID The unique identifier of the alert to retrieve. Required for "Get Alert" operation.
Query Parameters Optional additional parameters to customize the API request. Includes options like filters, sorting, pagination, date ranges, and token for authentication.

The Query Parameters collection supports these fields (not exhaustive):

  • end: End date/time filter.
  • filter: JSON object or string to filter results.
  • granularity: Level of detail or aggregation.
  • include: Additional related data to include.
  • page: Pagination settings as JSON.
  • sort: Sorting criteria as JSON or string.
  • start: Start date/time filter.
  • token: An optional token for authentication or session management.

Output

The node outputs the JSON response from the Commanders Act API corresponding to the requested alert. This typically includes all alert details such as its configuration, status, thresholds, and any metadata provided by the API.

If the API returns no content, the output will indicate a "204 No Content" status.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2 for all requests.
  • Proper permissions on the API key are necessary to access monitoring alerts.

Troubleshooting

  • Missing Alert ID: If the Alert ID is not provided when required, the node throws an error indicating that the Alert ID is mandatory.
  • API Credential Missing: The node will fail if the API credentials are not set up or invalid.
  • Invalid Query Parameters: Malformed JSON or unsupported query parameters may cause API errors.
  • Network or API Errors: Any connectivity issues or API-side errors will be surfaced as node errors with descriptive messages.
  • To resolve errors, ensure all required parameters are correctly set, credentials are valid, and the API endpoint is reachable.

Links and References

Discussion