Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically allowing users to manage and retrieve data related to "Web Containers" and their associated entities. The "Get Web Perimeter" operation fetches details about a specific web perimeter identified by its Perimeter ID. This is useful for scenarios where you need to programmatically access configuration or status information about web perimeters within your Commanders Act environment.

Practical examples include:

  • Retrieving perimeter details to audit or verify configurations.
  • Automating monitoring or reporting workflows that require perimeter metadata.
  • Integrating perimeter data into broader analytics or compliance systems.

Properties

Name Meaning
Perimeter ID The unique identifier of the web perimeter to retrieve.
Query Parameters Optional parameters to refine or filter the request. Includes options like date filters, sorting, pagination, and others as key-value pairs.

The "Query Parameters" collection supports multiple optional fields such as:

  • end, start: Date/time boundaries for filtering.
  • filter and various nested filter options (e.g., filter[begin_date], filter[search]).
  • granularity: Level of detail in returned data.
  • include: Additional related data to include.
  • page: Pagination controls.
  • sort: Sorting instructions.
  • token: An optional token parameter (password type).

Output

The output is a JSON array where each item corresponds to the response from the Commanders Act API for the requested web perimeter. The structure directly reflects the API's JSON response for a web perimeter resource, typically including properties such as perimeter configuration, rules, and metadata.

If the API returns no content, the node outputs an object indicating "204 No Content".

No binary data output is involved in 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.
  • Proper configuration of the API credentials in n8n is necessary before use.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: If the Perimeter ID is not provided when required, the node throws an error specifying that the Perimeter ID is required.
  • API Errors: Any errors returned by the Commanders Act API are caught and rethrown with descriptive messages. Common issues might include invalid IDs, permission issues, or network problems.
  • Parsing Errors: If the API returns a non-JSON string response, the node attempts to parse it; failure results in returning the raw text.

To resolve these issues:

  • Ensure API credentials are correctly configured.
  • Provide all required parameters, especially the Perimeter ID for this operation.
  • Check network connectivity and API endpoint availability.
  • Review API permissions and scopes assigned to the API key.

Links and References

Discussion