Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API

Overview

This node integrates with the Paperless NGX API to manage tags within the system. Specifically, the "Delete" operation for the "Tag" resource allows users to remove a tag by its unique identifier. This is useful in scenarios where tags are no longer relevant or were created erroneously, helping maintain an organized tagging system.

Practical examples include:

  • Automatically cleaning up obsolete tags after document archiving.
  • Removing tags that were applied incorrectly during batch processing.

Properties

Name Meaning
Note Informational notice explaining that owner and permissions fields accept numeric IDs, which can be retrieved using other nodes for Users and Groups.
Tag ID The unique numeric identifier of the tag to delete. This is required to specify which tag should be removed.

Output

The output JSON typically contains the response from the Paperless NGX API confirming the deletion of the tag. It may include status information or confirmation details. There is no binary data output associated with this operation.

Dependencies

  • Requires an active connection to the Paperless NGX API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the API instance must be set correctly in the credentials.
  • To retrieve valid User and Group IDs (for owner and permissions), additional nodes querying /api/users/ and /api/groups/ endpoints may be used as referenced in the note.

Troubleshooting

  • Invalid Tag ID: If the provided Tag ID does not exist, the API will likely return an error indicating the tag was not found. Verify the ID before attempting deletion.
  • Authentication Errors: Ensure the API key or token is valid and has sufficient permissions to delete tags.
  • Network Issues: Confirm that the API base URL is reachable and correct.
  • Permission Denied: The user associated with the API token might lack rights to delete tags; check user permissions in Paperless NGX.

Links and References

Discussion