Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Tag Rules, is designed to fetch tag rules from the Connect Secure API. It allows users to query and retrieve specific tagging rules based on various filtering and pagination parameters. This can be useful in scenarios where you want to programmatically access and manage tagging configurations, for example, to audit tags, synchronize them with other systems, or dynamically adjust workflows based on tag rules.

Practical examples include:

  • Retrieving all tag rules that match a certain condition or filter.
  • Paginating through large sets of tag rules using skip and limit parameters.
  • Sorting the retrieved tag rules by specified fields.

Properties

Name Meaning
X USER ID User Id header required for authentication or identification purposes in the API call.
Condition Query condition to filter which tag rules to retrieve (e.g., filter expressions).
Skip Number of records to skip, used for pagination.
Limit Maximum number of records to return, used for pagination.
Order By Field(s) by which to order the returned tag rules.

Output

The output of this operation is JSON data representing the retrieved tag rules matching the query parameters. The structure typically includes an array of tag rule objects, each containing details about individual tag rules as defined by the Connect Secure API.

If the API supports binary data for tag rules (not indicated here), it would be summarized accordingly, but based on the provided information, the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the Connect Secure API being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Missing or invalid X USER ID: Since the X USER ID header is required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure this property is correctly set.
  • Invalid query conditions: If the Condition parameter contains malformed or unsupported query syntax, the API may return errors or empty results. Validate the query format according to the API documentation.
  • Pagination issues: Setting Skip or Limit to inappropriate values (e.g., negative numbers) might cause errors or unexpected behavior.
  • API connectivity problems: Network issues or incorrect API credentials will prevent successful retrieval of tag rules. Verify network access and credential validity.

Links and References

Discussion