Graylog icon

Graylog

Consume Graylog API (v.1.1.0)

Overview

The Graylog node's "Decorators - Delete" operation allows users to delete a specific decorator from their Graylog instance via the Graylog API. This is useful for automating the management of decorators, which are used in Graylog to modify or enhance log message displays. Typical scenarios include removing obsolete or incorrect decorators as part of automated workflows, or integrating with other systems that manage Graylog configurations.

Example use cases:

  • Automatically cleaning up decorators after certain events.
  • Integrating Graylog configuration changes into CI/CD pipelines.
  • Removing test or temporary decorators as part of environment resets.

Properties

Name Type Meaning
Authentication options The authentication method to use (Token Authentication or Basic Authentication).
Id string The unique identifier of the decorator to be deleted.
Simplify boolean If enabled, simplifies the output structure for easier downstream processing.
Simplify Path string (Optional) Specifies a path to a property to return, further simplifying the output.

Output

  • The node outputs a json field containing the result of the delete operation.
  • If "Simplify" is enabled, the output will be a simplified version of the response, potentially filtered by the "Simplify Path" if provided.
  • The exact structure depends on the Graylog API's response for a successful or failed delete operation, but typically includes status information and possibly details about the deleted decorator.

Dependencies

  • External Services: Requires access to a running Graylog instance with API enabled.
  • API Credentials:
    • For Token Authentication: Requires a valid Graylog API token (graylogTokenApi credential).
    • For Basic Authentication: Requires Graylog username and password (graylogBasicApi credential).
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n under the node's credential options.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the provided API token or username/password is incorrect, authentication will fail.
  • Decorator Not Found: If the specified "Id" does not correspond to an existing decorator, the API may return a "not found" error.
  • Insufficient Permissions: The user associated with the credentials must have permission to delete decorators.

Common Error Messages:

  • "Authentication failed": Check your credentials and authentication method.
  • "Decorator not found": Verify the "Id" property matches an existing decorator.
  • "Permission denied": Ensure the user has sufficient rights in Graylog.

Links and References

Discussion