Zorus icon

Zorus

Interact with Zorus API

Actions13

Overview

The node named "Zorus" provides integration with the Zorus API, allowing users to interact with various resources including policies. Specifically, the "Search Policy" operation enables querying and retrieving policy records based on multiple filtering criteria such as UUIDs, group or customer names, creation dates, and sorting preferences. This operation is useful for scenarios where you need to programmatically search for policies matching specific conditions, paginate through large result sets, or sort results by different properties.

Practical examples include:

  • Retrieving all policies created after a certain date for audit purposes.
  • Searching for policies belonging to a particular customer or group.
  • Paginating through policies in batches of 10 or 20 for display in a dashboard.
  • Sorting policies by creation date or other attributes in ascending or descending order.

Properties

Name Meaning
Page The page number to retrieve in the paginated results (default: 1).
Page Size Number of policy items to retrieve per page (default: 10).
Sort Property The property by which to sort the returned policies (default: "createdAt").
Sort Ascending Whether to sort the results in ascending order (true) or descending order (false).
UUID Equals Filter to get the policy with the exact specified UUID.
Group UUID Equals Filter to get policies belonging to the group with the specified UUID.
Group Name Contains Filter to get policies where the group name contains this string.
Customer Name Contains Filter to get policies where the customer name contains this string.
Customer UUID Equals Filter to get policies belonging to the customer with the specified UUID.
Created Before Filter to get policies created before this date (ISO 8601 string).
Created After Filter to get policies created after this date (ISO 8601 string).

Output

The output of the "Search Policy" operation is a JSON array containing policy objects that match the specified filters and pagination settings. Each policy object includes details as defined by the Zorus API's policy schema (not detailed here). The output does not explicitly mention binary data, so it is assumed to be purely JSON.

Example structure of each item in the output json field might include fields like:

{
  "uuid": "string",
  "groupUuid": "string",
  "customerUuid": "string",
  "createdAt": "string",
  "policyDetails": { /* ... */ }
}

Dependencies

  • Requires an API key credential for authenticating requests to the Zorus API.
  • The base URL for API requests is https://developer.zorustech.com/api.
  • The node expects the API version header "Zorus-Api-Version": "1.0" to be set.
  • No additional external dependencies are indicated beyond the API access.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Providing invalid filter values (e.g., malformed UUIDs or dates) may result in API errors or empty results.
    • Pagination parameters out of range could lead to no data being returned.
  • Error messages:
    • Authentication errors typically indicate problems with the API key; verify the credential setup.
    • Validation errors from the API may indicate incorrect filter formats; ensure UUIDs and dates follow expected formats.
    • Network or connectivity errors suggest checking internet connection or API availability.

Links and References

Discussion