Redirect

list of redirects

Get all redirects

get

/redirect

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

success

create redirect

post

/redirect

Authorizations

Body

urlstring

URL

Example: www.example.com

destinationstring

Destination URL

Example: https://www.google.com

destinationsarray[string]

More Destinations

Example: []

typestring

Type

Example: 301

forward_pathboolean

whether forwarding slug to destination

Example: false

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/redirect' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"url":"www.example.com","destination":"https://www.google.com","destinations":"[]","type":"301","forward_path":false,"forward_query":false}'

200

200

{
  "data": null
}

success

Get details about a specific redirect by id

get

/redirect/{id}

Authorizations

Path parameters

idstring · stringrequired

redirect id

Example: 1639562002248499321

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

success

update redirect

put

/redirect/{id}

Authorizations

Path parameters

idstring · stringrequired

redirect id

Example: 1639562002248499321

Body

urlstring

URL

Example: www.example.com

destinationstring

Destination URL

Example: https://www.google.com

destinationsarray[string]

More Destinations

Example: []

typestring

Type

Example: 301

forward_pathboolean

whether forwarding slug to destination

Example: false

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/redirect/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"url":"www.example.com","destination":"https://www.google.com","destinations":"[]","type":"301","forward_path":false,"forward_query":false}'

200

200

{
  "data": null
}

success

delete redirect

delete

/redirect/{id}

Authorizations

Path parameters

idstring · stringrequired

redirect id

Example: 1639562002248499321

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "data": null
}

success