NATS Object Store icon

NATS Object Store

Store and retrieve objects (files, data) in NATS JetStream Object Store - manage buckets and objects

Overview

This node integrates with NATS JetStream Object Store, allowing users to manage buckets and objects within those buckets. Specifically, the "Bucket - Get Status" operation retrieves the status or metadata of a specified object store bucket. This is useful for scenarios where you want to verify bucket existence, check its configuration, or monitor its state before performing further operations like uploading or deleting objects.

Practical examples include:

  • Checking if a bucket exists before attempting to upload files.
  • Retrieving bucket metadata to audit storage usage or configuration.
  • Monitoring bucket health/status in automated workflows.

Properties

Name Meaning
Bucket Name The name of the Object Store bucket to operate on. Bucket names can only contain alphanumeric characters, dashes, and underscores.

Output

The output JSON contains the result of the bucket status retrieval operation. It typically includes metadata about the bucket such as its configuration, creation time, and other relevant status information provided by the NATS JetStream Object Store API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a NATS JetStream server.
  • Needs an API key credential configured in n8n for authenticating with the NATS server.
  • Uses internal utilities for connection management, logging, and bucket name validation.

Troubleshooting

  • Invalid Bucket Name: If the bucket name contains invalid characters (anything other than alphanumeric, dashes, or underscores), the node will throw a validation error. Ensure bucket names conform to allowed characters.
  • Unknown Operation Error: If an unsupported operation is selected, the node throws an error indicating the operation is unknown.
  • Connection Issues: Failure to connect to the NATS server due to incorrect credentials or network issues will cause errors. Verify credentials and network accessibility.
  • Bucket Not Found: If the specified bucket does not exist, the node may return an error or empty status. Confirm the bucket name is correct and that it exists on the server.
  • Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion