Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to create a link share for a specified project. A link share allows users to share access to a project via a generated link, optionally protected by a password and with configurable permission levels. This is useful for collaboration scenarios where you want to grant external or limited access to a project without adding users directly.

Practical examples:

  • Sharing a project with clients or stakeholders who do not have full user accounts.
  • Creating read-only or editable links for team members or external collaborators.
  • Generating password-protected links for sensitive projects.

Properties

Name Meaning
Project Title or ID The target project to create the link share for. Can be selected from a searchable list of projects or specified by ID.
Right The permission level granted by the link share: "Read Only", "Read & Write", or "Admin".
Additional Fields Optional settings for the link share:
- Name A custom name for the link share. Actions performed while authenticated with this link will be associated with this name.
- Password A password to protect the link share. It can only be set during creation and not retrieved later.
- Sharing Type Whether the link share requires a password ("With Password") or not ("Without Password").

Output

The node outputs JSON data representing the created link share object returned by the Vikunja API. This typically includes details such as the link URL, permissions, name, and other metadata about the share.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Vikunja API.
  • Needs the base URL of the Vikunja instance configured in the credentials.
  • Uses HTTP requests to interact with the Vikunja REST API endpoints.

Troubleshooting

  • Invalid Project ID or Not Found: If the specified project does not exist or the ID is incorrect, the API will return an error. Verify the project ID or select from the list.
  • Insufficient Permissions: The API key used must have rights to create link shares on the project; otherwise, authorization errors may occur.
  • Password Issues: Once set, the password cannot be retrieved or changed via this node. To update the password, the link share must be recreated.
  • Network or API Errors: Ensure the base URL and API key are correctly configured and that the Vikunja server is reachable.

Links and References

Discussion