AvantGuard - DNSFilterInstall

Overview

This node operation creates a new API key. It is useful in scenarios where you need to programmatically generate API keys for accessing services or applications that require authentication via API keys. For example, an administrator might use this node to automate the creation of API keys for new users or services, specifying optional parameters such as the key's name and expiry date.

Properties

Output

The node outputs JSON data representing the newly created API key details. This typically includes information such as the key value, its name, expiry date, and any other metadata returned by the API upon successful creation. There is no indication that binary data is output by this node.

Dependencies

• Requires an API key credential for authenticating requests to the external service managing API keys.
• The node sends HTTP requests with JSON payloads to the configured API endpoint.
• No additional environment variables or configurations are explicitly required beyond the API authentication setup.

Troubleshooting

• Common Issues:

  • Missing or invalid API authentication token can cause authorization errors.
  • Incorrectly formatted expiry date may lead to validation errors from the API.
  • Omitting required fields (if any beyond those shown) could result in request failures.

• Error Messages:

  • Authorization errors typically indicate issues with the provided API credentials; verify and update them as needed.
  • Validation errors related to the body fields suggest checking the format and presence of required properties like name and expiry.
  • Network or connectivity errors imply checking the base URL configuration and network access.

Links and References

• Refer to the API provider’s documentation for detailed information on API key creation endpoints and accepted parameters.
• ISO 8601 date format reference: https://en.wikipedia.org/wiki/ISO_8601