Dokploy

redirects

POST/redirects.create

redirects-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

regex
Required
string

Minimum length: 1

replacement
Required
string

Minimum length: 1

permanent
Required
boolean

applicationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redirects.create" \
  -d '{
  "regex": "string",
  "replacement": "string",
  "permanent": true,
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/redirects.one

redirects-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

redirectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/redirects.one?redirectId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redirects.delete

redirects-delete

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redirectId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redirects.delete" \
  -d '{
  "redirectId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/redirects.update

redirects-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redirectId
Required
string

Minimum length: 1

regex
Required
string

Minimum length: 1

replacement
Required
string

Minimum length: 1

permanent
Required
boolean

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redirects.update" \
  -d '{
  "redirectId": "string",
  "regex": "string",
  "replacement": "string",
  "permanent": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Previous

project

Next

redis

On this page

redirects-createAuthorizationRequest Bodyredirects-oneAuthorizationQuery Parametersredirects-deleteAuthorizationRequest Bodyredirects-updateAuthorizationRequest Body