POST
/
links
Create a shortened link
curl --request POST \
  --url https://ishortn.ink/api/v1/links \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "https://example.com",
  "expiresAt": "2024-12-31T23:59:59Z",
  "expiresAfter": 1000,
  "domain": "example.com",
  "alias": "customAlias",
  "password": "securePassword"
}'
{
  "shortLink": "https://ishortn.ink/customAlias",
  "url": "https://example.com",
  "alias": "customAlias",
  "expiresAt": "2024-12-31T23:59:59Z",
  "expiresAfter": 1000,
  "isProtected": true
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<url>
required

The URL to shorten.

​
expiresAt
string<date-time> | null

The date and time when the link expires.

​
expiresAfter
integer | null

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

Link created successfully

​
shortLink
string

The shortened link.

​
url
string

The original URL.

​
alias
string

The alias of the shortened link.

​
expiresAt
string<date-time> | null

The expiration date and time of the link.

​
expiresAfter
integer | null

The number of clicks after which the link expires.

​
isProtected
boolean

Indicates if the link is password protected (relevant for creation response).