👋 Hey everyone! Wondering why Shortiny is completely free? No catch, we promise! We're passionate about making top-quality URL shortening accessible to all. Rest assured, existing users will keep enjoying all features for free. If we ever introduce paid plans in the future, it will only apply to new users. Spread the word and invite your friends to grab their free accounts now! 🚀

Domains

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET 
https://shortiny.com/api/v1/domains

Request example: 

curl --location --request GET 'https://shortiny.com/api/v1/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
search_by
optional string
Search by. Possible values are: name for Name. Defaults to: name.
sort_by
optional string
Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional integer
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 25.
Show

API endpoint:

GET 
https://shortiny.com/api/v1/domains/{id}

Request example: 

curl --location --request GET 'https://shortiny.com/api/v1/domains/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://shortiny.com/api/v1/domains

Request example: 

curl --location --request POST 'https://shortiny.com/api/v1/domains' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parameter
Type
Description
name
required string
The domain name.
index_page
optional string
The index page to redirect to.
not_found_page
optional string
The 404 page to redirect to.
Update

API endpoint:

PUT PATCH 
https://shortiny.com/api/v1/domains/{id}

Request example: 

curl --location --request PUT 'https://shortiny.com/api/v1/domains/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
index_page
optional string
The index page to redirect to.
not_found_page
optional string
The 404 page to redirect to.
Delete

API endpoint:

DELETE 
https://shortiny.com/api/v1/domains/{id}

Request example: 

curl --location --request DELETE 'https://shortiny.com/api/v1/domains/{id}' \
--header 'Authorization: Bearer {api_key}'