Link

Create new link

PUT {{HOST}}/api/v1/link

This endpoint allows you to create a new short link

Headers

Name	Type	Description
x-client-id	string
x-client-secret	string

Request Body

Name	Type	Description
slug_length	string	The length required for the link id
ttl	integer	The TTL for the link
url	string	The url to shorten

200 Link created with success

{
    "slug": "tuRuxb",
    "url": "{{HOST}}/tuRuxb"
}

400

Malformated request, the TTL is too high or the slug length is invalid (max 20)

401

	Wrong credentials

409

Can't generate a new link with this slug size

Delete link

DELETE {{HOST}}/api/v1/link

This endpoint allow you to delete a link

Headers

Name	Type	Description
x-client-id	string
x-client-secret	string

Request Body

Name	Type	Description
slug	string	The link id

200

The link has been deleted with success

400

Malformated request or the slug is invalid

401

Wrong credentials

Update link

PATCH {{HOST}}/api/v1/link

If the link is not expired you can update the target url and the ttl

Headers

Name	Type	Description
x-client-id	string
x-client-secret	string

Request Body

Name	Type	Description
ttl	integer
url	string
slug	string	The link id

200