Link

list of short urls

Get all short urls

get

/link

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.redirhub.com/v1/link' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "data": [
    {
      "id": "72288a61-034e-4596-80c9-88751cf0a937",
      "host": "www.example.com",
      "url": "www.example.com",
      "alias": "aBD",
      "https": true,
      "destination": "https://www.google.com",
      "destinations": "[]",
      "type": "301",
      "status": "active",
      "forward_query": false,
      "created_at": "2023-11-15T15:09:14.000000Z",
      "updated_at": "2023-11-15T15:09:14.000000Z"
    }
  ]
}

success

create short url

post

/link

Authorizations

Body

hoststringrequired

Hostname

Example: url.com

aliasstring

Slug

Example: 123

destinationstringrequired

Destination URL

Example: https://www.google.com

typestring

Type

Example: 301

forward_queryboolean

whether forwarding query params to destination

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.redirhub.com/v1/link' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"host":"url.com","alias":"123","destination":"https://www.google.com","type":"301","forward_query":false}'

200

200

{
  "data": null
}

success

Get details about a specific short url by id

get

/link/{id}

Authorizations

Path parameters

idstring · stringrequired

short url id

Example: 1639562002248499321

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.redirhub.com/v1/link/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "id": "72288a61-034e-4596-80c9-88751cf0a937",
  "host": "www.example.com",
  "url": "www.example.com",
  "alias": "aBD",
  "https": true,
  "destination": "https://www.google.com",
  "destinations": "[]",
  "type": "301",
  "status": "active",
  "forward_query": false,
  "created_at": "2023-11-15T15:09:14.000000Z",
  "updated_at": "2023-11-15T15:09:14.000000Z"
}

success

update short url

put

/link/{id}

Authorizations

Path parameters

idstring · stringrequired

short url id

Example: 1639562002248499321

Body

hoststringrequired

Hostname

Example: url.com

aliasstring

Slug

Example: 123

destinationstringrequired

Destination URL

Example: https://www.google.com

typestring

Type

Example: 301

forward_queryboolean

whether forwarding query params to destination

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.redirhub.com/v1/link/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"host":"url.com","alias":"123","destination":"https://www.google.com","type":"301","forward_query":false}'

200

200

{
  "data": null
}

success

delete short url

delete

/link/{id}

Authorizations

Path parameters

idstring · stringrequired

short url id

Example: 1639562002248499321

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.redirhub.com/v1/link/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "data": null
}

success