Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node interacts with the Paperless NGX API to update an existing Storage Path entity. A Storage Path in Paperless NGX represents a file system location where documents are stored and can be automatically assigned based on matching criteria.

This operation is useful when you want to modify properties of a storage path such as its name, physical path, document matching rules, ownership, or permissions without creating a new one. For example, you might update the matching algorithm to improve automatic document classification or change the owner user ID to reflect organizational changes.

Practical scenarios include:

  • Adjusting the file system path if the storage location has moved.
  • Refining document matching criteria to better categorize incoming documents.
  • Updating access permissions to restrict or grant users/groups different levels of control over the storage path.

Properties

Name Meaning
Note (globalPermissionsNote) Informational notice that Owner and Permissions fields accept numeric IDs. Users should retrieve available User and Group IDs via separate API calls or nodes.
Name (name) The name identifier for the storage path. Required.
Path (path) The actual file system path associated with this storage path. Required.
Match (match) A string used by Paperless NGX to match against document content for automatic assignment to this storage path.
Matching Algorithm (matchingAlgorithm) The method used to match documents to this storage path. Options include: None, Any word, All words, Literal string, Regular Expression, Fuzzy Match, or Auto (automatic selection). Default is None.
Case Insensitive (isInsensitive) Boolean flag indicating whether the matching should ignore case differences. Default is false.
Owner User ID (owner) Numeric user ID to assign 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 must provide numeric IDs.
Note (permissionsNote) Informational notice reminding users to use separate endpoints to look up User and Group IDs for permissions. This node does not support creating/updating/deleting users or groups.
Storage Path ID (id) Numeric ID of the storage path to update. Required to identify which storage path is being modified.

Output

The node outputs the updated storage path data in the json field of the output items. This typically includes all properties of the storage path after the update, such as its ID, name, path, matching criteria, owner, and permissions.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a Paperless NGX instance via its REST API.
  • An API key or token credential is required for authentication.
  • The base URL of the Paperless NGX instance must be configured in the node credentials.
  • To set owner and permissions, users and groups must be retrieved separately using appropriate API endpoints or nodes.

Troubleshooting

  • Invalid Storage Path ID: If the provided storage path ID does not exist, the API will return an error. Verify the ID before updating.
  • Permission Errors: Insufficient API credentials or incorrect permission settings may cause authorization failures. Ensure the API key has rights to update storage paths.
  • Malformed Permissions JSON: The setPermissions property must be a valid JSON object with correct structure. Invalid JSON or missing keys can cause errors.
  • Matching Algorithm Mismatch: Providing an invalid value for the matching algorithm option may result in rejection by the API.
  • Owner User ID Not Found: Specifying a non-existent user ID as owner will cause an error. Confirm user IDs via the Users endpoint.
  • Case Sensitivity Issues: If matching behaves unexpectedly, verify the isInsensitive flag aligns with your intended matching behavior.

Links and References

Discussion