Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Discovery Settings, is designed to fetch discovery settings data from the Connect Secure API. It allows users to query and retrieve specific discovery configuration records based on various filtering, pagination, and sorting parameters. This operation is useful in scenarios where you need to programmatically access or audit discovery settings, for example, to integrate with other systems, automate reporting, or synchronize configurations.

Practical examples include:

  • Retrieving a subset of discovery settings filtered by certain conditions.
  • Paginating through large sets of discovery settings using skip and limit.
  • Sorting the results 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 string to filter discovery settings records (e.g., filter expressions).
Skip Number of records to skip for pagination purposes.
Limit Maximum number of records to return.
Order By Field(s) to order the returned records by (sorting criteria).

Output

The output of this operation is JSON data representing the retrieved discovery settings records. Each item in the output corresponds to a discovery setting entry matching the query parameters. The structure typically includes all relevant fields of a discovery setting as defined by the Connect Secure API schema.

There is no indication that this node outputs binary data; it focuses on JSON structured data.

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 credential.

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 the user ID is correct and provided.
  • Invalid query conditions: Malformed or unsupported query strings in the Condition property may result in API errors or empty responses. Validate the syntax according to the API documentation.
  • Pagination issues: Setting Skip or Limit incorrectly (e.g., negative numbers) might cause unexpected results or errors.
  • API connectivity problems: Network issues or incorrect API credentials can lead to failures in retrieving data. Verify network access and credential validity.
  • Order By field errors: Specifying invalid fields in Order By may cause the API to reject the request.

Links and References


Note: The above summary is based solely on static analysis of the provided source code and property definitions.

Discussion