Shlink icon

Shlink

Interact with Shlink URL Shortener API

Actions12

Overview

This node integrates with the Shlink URL Shortener API to manage tags associated with short URLs. Specifically, the "Rename" operation for the "Tag" resource allows users to rename an existing tag in their Shlink instance.

Use cases include:

  • Organizing and updating tag names to better reflect changes in your URL categorization strategy.
  • Correcting typos or standardizing tag naming conventions across your short URLs.

For example, if you have a tag named "promo2023" but want to rename it to "spring-promo-2023", this operation will update all references of that tag accordingly.

Properties

Name Meaning
Tag Name The current name of the tag to rename.
New Tag Name The new name to assign to the tag.

Output

The output is a JSON object representing the response from the Shlink API after renaming the tag. This typically includes details about the updated tag, confirming the rename operation was successful.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Shlink API.
  • Needs the base URL of the Shlink instance configured in the credentials.
  • The node makes HTTP PUT requests to the Shlink API endpoint /rest/v3/tags/{tagName} with a JSON body containing the new tag name.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing a non-existent tag name will result in an error from the API indicating the tag was not found.
    • Network connectivity problems can prevent the request from reaching the Shlink server.
  • Error messages:

    • Request failed: followed by the error message usually indicates network or authentication issues.
    • Response status: HTTP status codes like 404 indicate the tag does not exist; 401 or 403 indicate authentication/authorization problems.
  • Resolutions:

    • Verify the API key and base URL are correctly set in the node credentials.
    • Ensure the tag name exists before attempting to rename.
    • Check network connectivity and firewall settings.

Links and References

Discussion