Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node provides integration with the Paperless NGX API, specifically allowing partial updates to a Storage Path resource. This operation is useful when you want to modify only certain attributes of an existing storage path without replacing the entire entity.

Common scenarios include:

  • Updating the name or file system path of a storage location.
  • Adjusting document matching criteria to automatically assign documents to this storage path.
  • Changing ownership or permissions for access control on the storage path.

Practical example:

  • You have a storage path that automatically categorizes invoices but want to refine the matching algorithm or update the owner user ID without affecting other properties.

Properties

Name Meaning
Note (globalPermissionsNote) Informational notice explaining that Owner and Permissions fields accept numeric IDs, and users/groups can be retrieved via separate endpoints.
Storage Path ID (id) The unique numeric identifier of the storage path to update. This is required to specify which storage path will be partially updated.
Name (name) Optional new name for the storage path.
Path (path) Optional new file system path for the storage path.
Match (match) Optional string used by Paperless NGX to match against document content for automatic assignment to this storage path.
Matching Algorithm (matchingAlgorithm) The algorithm used to match documents to this storage path. Options include: None, Any word, All words, Literal string, Regular Expression, Fuzzy Match, Auto (automatic selection). Default is None.
Case Insensitive (isInsensitive) Boolean flag indicating whether the matching should ignore case differences. Defaults to false.
Owner User ID (owner) Numeric user ID to set as the owner of this storage path.
Set Permissions (setPermissions) JSON object defining view and change permissions for users and groups. Structure: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}. Users and groups must be specified by their numeric IDs.

Additional note property (permissionsNote) reminds users to use separate endpoints to look up user and group IDs since this node does not provide create/update/delete operations for them.

Output

The node outputs the JSON response from the Paperless NGX API representing the updated storage path object. This typically includes all current properties of the storage path after the partial update, such as its ID, name, path, matching settings, owner, and permissions.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to a Paperless NGX instance via its REST API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • Users and groups referenced in permissions and ownership must exist in the Paperless NGX system; their numeric IDs must be obtained separately (e.g., via dedicated nodes querying /api/users/ and /api/groups/).

Troubleshooting

  • Invalid or missing Storage Path ID: Ensure the id property is provided and corresponds to an existing storage path.
  • Permission errors: Verify that the API token has sufficient rights to update storage paths and that user/group IDs in permissions are valid.
  • Malformed JSON in permissions: The setPermissions field must be a valid JSON object matching the expected structure.
  • Matching algorithm issues: If documents are not being assigned correctly, check the match string and matchingAlgorithm settings, including case sensitivity.
  • API connectivity problems: Confirm the base URL and credentials are correctly configured and the Paperless NGX instance is reachable.

Links and References

Discussion