Create a short link

Creates a shortened link with optional parameters for expiration, alias, and password protection.

Authorizations

x-api-key

string

headerrequired

Body

application/json

url

string

required

The URL to shorten.

expiresAt

string

The date and time when the link expires.

expiresAfter

integer

The number of clicks after which the link expires.

domain

string

If you have a custom domain, you can specify it here.

alias

string

Custom alias for the shortened link.

password

string

Password to protect the link. (Only for pro users)

Response

201 - application/json

shortLink

string

The shortened link.

url

string

The original URL.

alias

string

The alias of the shortened link.

expiresAt

string

The expiration date and time of the link.

expiresAfter

integer

The number of clicks after which the link expires.

isProtected

boolean

Indicates if the link is password protected.