# Shlink

## API Reference

- [Shlink REST API](https://sourcey-shlink.pages.dev/documentation/api/v4/index.md): Shlink, the self-hosted URL shortener
- [List short URLs](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-get.md): Returns the list of short URLs.
- [Create short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-post.md): Creates a new short URL. Param findIfExists: This new param allows to force shlink to return existing short URLs when found based on provided params, instead of creating a new one. However, it might add complexity and have unexpected outputs.
- [Create a short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shorten-get.md): [Deprecated] Use Create short URL instead
- [Parse short code](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-get.md): Get the long URL behind a short URL's short code.
- [Delete short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-delete.md): Deletes the short URL for provided short code.
- [Edit short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-patch.md): Update certain meta arguments from an existing short URL.
- [List short URL redirect rules](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-redirect-rules-get.md): Returns the list of redirect rules for a short URL.
- [Set short URL redirect rules](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-redirect-rules-post.md): Sets redirect rules for a short URL, with priorities matching the order in which they are provided.
- [List existing tags](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-tags-get.md): Returns the list of all tags used in any short URL
- [Rename tag](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-tags-put.md): Renames one existing tag
- [Delete tags](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-tags-delete.md): Deletes provided list of tags
- [Get tags with stats](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-tags-stats-get.md): Returns the list of all tags used in any short URL, together with the amount of short URLs and visits for it
- [Get general visits stats](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-visits-get.md): Get general visits stats not linked to one specific short URL.
- [List visits for short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-visits-get.md): Get the list of visits on the short URL behind provided short code.
- [Delete visits for short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-short-urls-shortcode-visits-delete.md): Delete all existing visits on the short URL behind provided short code.
- [List visits for tag](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-tags-tag-visits-get.md): Get the list of visits on any short URL which is tagged with provided tag.
- [List visits for domain](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-domains-domain-visits-get.md): Get the list of visits on any short URL which belongs to provided domain.
- [List orphan visits](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-visits-orphan-get.md): Get the list of visits to invalid short URLs, the base URL or any other 404.
- [Delete orphan visits](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-visits-orphan-delete.md): Delete all visits to invalid short URLs, the base URL or any other 404.
- [List non-orphan visits](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-visits-non-orphan-get.md): Get the list of visits to any short URL.
- [List configured domains](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-domains-get.md): Returns the list of all domains that have been either used for some short URL, or have explicitly configured redirects. It also includes the domain redirects, plus the default redirects that will be used for any non-explicitly-configured one.
- [Sets domain "not found" redirects](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-domains-redirects-patch.md): Sets the URLs that you want a visitor to get redirected to for "not found" URLs for a specific domain
- [Get mercure integration info](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-v-version-mercure-info-get.md): Returns information to consume updates published by Shlink on a mercure hub. https://mercure.rocks/
- [Check healthiness](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-rest-health-get.md): Checks the healthiness of the service, making sure it can access required resources.
- [Short URL](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-shortcode-get.md): Represents a short URL. Tracks the visit and redirects tio the corresponding long URL
- [Short URL tracking pixel](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-shortcode-track-get.md): Generates a 1px transparent image which can be used to track emails with a short URL
- [[Deprecated] Short URL QR code](https://sourcey-shlink.pages.dev/documentation/api/v4/operations/operation-shortcode-qr-code-get.md): [Deprecated] Use an external mechanism to generate QR codes. Shlink dashboard and shlink-web-client provide their own.