This is a simple URL shortener service designed to be used privately. It runs on Cloudflare Workers and utilizes Workers KV. You can either access it through the API or the web interface.
- API and Browser Access: You can access the service either via the API or through the web interface.
- Authenticated URL Shortening: You must provide an API key either as an
api-keycookie or anx-api-keyheader to shorten URLs. You do not need the api key to use the shortened urls. - Custom Expiry: You can specify an expiry time for the link.
- Setup Workers KV and add it to
wrangler.toml - Deploy it on Cloudflare Pages. Make sure to set the
API_KEYenvironment variable for your secret API key. - Head to /admin in the browser to log in and get started with making shortlinks.
POST /:slug
Request Body:
{
"url": "https://example.com", // required
"expiry": 2147483647 // optional unix seconds
}A response of 200 indicates that the shortlink has been created
DELETE /:slug
Authentication is required for shortening URLs. You can authenticate by passing the API key either in an api-key cookie or in the x-api-key header.
When deploying, ensure to set the API_KEY environment variable for the secret API key for authentication.
- View all active shortlinks
- Update a link pointed by a slug without affecting its expiry
- Delete shortlinks
- Make an existing shortlink expire later
This project is licensed under the GNU AGPL - see the license file for details.
This project is not an IP grabber. Read our privacy policy for details.