Create a permanent link
Mints a code that never stops resolving. Send an API key to create it on your account, or send no credentials at all to get a 402 machine-payment challenge and buy a single permanent link outright.
Every link is created in quarantine, which forces a live safety check on each resolution until it earns release. That is a property of the link, not of who paid for it — a quarantined link resolves normally.
Body
Where the code resolves to. http/https only; localhost, private ranges and cloud metadata endpoints are refused. Stored normalised, so HTTPS://Example.COM and https://example.com/ are the same link.
1"https://example.com/spring-menu"
The path segment the code resolves on. Drawn from an unambiguous alphabet (no 0/O, no 1/l/I) because people type these off printed material. Omit on create and one is allocated for you.
"m4rq7bd"
A verified custom domain to mint the code on. Requires a subscription.
"dom_2YgQk1p8fT3mN7wCxRvBdLsHjZa"
Response
The link was created. A key-authenticated call gets Link; a call that paid gets PaidLink, which adds the printable short URL and — on the first paid link of a new machine account — the API key to repoint it.
- Option 1
- Option 2
A permanent link. Once issued, it never stops resolving.
"lnk_2YgQk1p8fT3mN7wCxRvBdLsHjZa"
The path segment the code resolves on. Drawn from an unambiguous alphabet (no 0/O, no 1/l/I) because people type these off printed material. Omit on create and one is allocated for you.
"m4rq7bd"
Where the code resolves to. http/https only; localhost, private ranges and cloud metadata endpoints are refused. Stored normalised, so HTTPS://Example.COM and https://example.com/ are the same link.
1"https://example.com/spring-menu"
The custom domain this link resolves on, or null for the default domain.
null
0 = active, 1 = quarantine, 2 = abuse. Every link is created in quarantine, which forces a live safety check on each resolution until the link earns release: three clean checks once it is at least seven days old. Quarantine is a property of the link, never of the account — it is not a paywall and a quarantined link still resolves.
1