Link

list of short urls

Get all short urls

GEThttps://api.redirhub.com/v1/link

Authorization

sanctum

Response

200

success

Body

application/json

dataarray of V1LinkResource (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.redirhub.com/v1/link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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"
    }
  ]
}

create short url

POSThttps://api.redirhub.com/v1/link

Authorization

sanctum

Body

application/json

host*string

Hostname

Example: "url.com"

aliasstring

Slug

Example: "123"

destination*string

Destination URL

Example: "https://www.google.com"

typestring

Type

Example: "301"

forward_queryboolean

whether forwarding query params to destination

Example: false

Response

200

success

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.redirhub.com/v1/link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "destination": "https://www.google.com",
      "host": "url.com"
    }),
});
const data = await response.json();

Response

200

{
  "data": null
}

Get details about a specific short url by id

GEThttps://api.redirhub.com/v1/link/{id}

Authorization

sanctum

Path parameters

id*string (string)

short url id

Example: "1639562002248499321"

Response

200

success

Body

application/json

idstring

Item id

Example: "72288a61-034e-4596-80c9-88751cf0a937"

hoststring

Hostname

Example: "www.example.com"

urlstring

URL

Example: "www.example.com"

aliasstring

URL Slug

Example: "aBD"

httpsboolean

whether HTTPS support

Example: true

destinationstring

Destination URL

Example: "https://www.google.com"

destinationsarray[string]

More Destinations

Example: "[]"

typestring

Type

Example: "301"

statusstring

Status

Example: "active"

forward_queryboolean

whether forwarding query params to destination

Example: false

created_attime

created at

Example: "2023-11-15T15:09:14.000000Z"

updated_attime

updated at

Example: "2023-11-15T15:09:14.000000Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.redirhub.com/v1/link/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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"
}

update short url

PUThttps://api.redirhub.com/v1/link/{id}

Authorization

sanctum

Path parameters

id*string (string)

short url id

Example: "1639562002248499321"

Body

application/json

host*string

Hostname

Example: "url.com"

aliasstring

Slug

Example: "123"

destination*string

Destination URL

Example: "https://www.google.com"

typestring

Type

Example: "301"

forward_queryboolean

whether forwarding query params to destination

Example: false

Response

200

success

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.redirhub.com/v1/link/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "destination": "https://www.google.com",
      "host": "url.com"
    }),
});
const data = await response.json();

Response

200

{
  "data": null
}

delete short url

DELETEhttps://api.redirhub.com/v1/link/{id}

Authorization

sanctum

Path parameters

id*string (string)

short url id

Example: "1639562002248499321"

Response

200

success

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.redirhub.com/v1/link/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": null
}