GuidesAPI ReferenceChangelog
API Reference
Start typing to search…

Create a new link using public API key

post
https://api.short.io/links/public

This method creates a new link. Only this method should be used in client-side applications

If parameter "path" is omitted, it generates path by algorithm, chosen in domain settings.

You can use it with public API key in your frontend applications (client-side javascript, Android & iPhone apps) Rate limit: 20/s

Body Params
string
required

Original URL

boolean

Cloaking

string

Link password

integer | null
enum

HTTP code for redirect

Allowed:

Link expiration date in milliseconds or ISO string

string | null

Expired URL

string

Link title

tags
array of strings

Array of link tags

tags
string

set utm_source parameter to destination link

string

set utm_medium parameter to destination link

string

set utm_campaign parameter to destination link

string

set utm_term parameter to destination link

string

set utm_content parameter to destination link

Time to live in milliseconds or ISO string

string | null

Link slug

string | null

Android URL

string | null

iPhone URL

Link creation date in milliseconds

integer | null
≥ 1

disable link after specified number of clicks

boolean | null

Provide your email to users to get a password

boolean
Defaults to false

Skip query string merging

boolean
Defaults to false

Link is archived

string | null

Split URL

integer | null
1 to 100

Split URL percentage

string | null

Adroll integration

string | null

Facebook integration

string | null

Google Analytics integration

string | null

Google Tag Manager integration

string
required
string
Responses

Updated 5 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago