Dokploy

redis

POST/redis.create

redis-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

databasePassword
Required
string

dockerImagestring

Default: "redis:8"

projectId
Required
string

descriptionstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "databasePassword": "string",
  "dockerImage": "redis:8",
  "projectId": "string",
  "description": "string"
}'

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

GET/redis.one

redis-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/redis.one?redisId=string"

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

POST/redis.start

redis-start

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.start" \
  -d '{
  "redisId": "string"
}'

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

POST/redis.reload

redis-reload

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.reload" \
  -d '{
  "redisId": "string",
  "appName": "string"
}'

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

POST/redis.stop

redis-stop

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.stop" \
  -d '{
  "redisId": "string"
}'

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

POST/redis.saveExternalPort

redis-saveExternalPort

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

externalPort
Required
number | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.saveExternalPort" \
  -d '{
  "redisId": "string",
  "externalPort": 0
}'

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

POST/redis.deploy

redis-deploy

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.deploy" \
  -d '{
  "redisId": "string"
}'

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

POST/redis.changeStatus

redis-changeStatus

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.changeStatus" \
  -d '{
  "redisId": "string",
  "applicationStatus": "idle"
}'

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

POST/redis.remove

redis-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.remove" \
  -d '{
  "redisId": "string"
}'

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

POST/redis.saveEnvironment

redis-saveEnvironment

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

envstring | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.saveEnvironment" \
  -d '{
  "redisId": "string",
  "env": "string"
}'

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

POST/redis.update

redis-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

redisId
Required
string

Minimum length: 1

namestring

Minimum length: 1

appNamestring

Minimum length: 1

descriptionstring | null

databasePasswordstring

dockerImagestring

Default: "redis:8"

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

createdAtstring

applicationStatusstring

Value in: "idle" | "running" | "done" | "error"

projectIdstring

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/redis.update" \
  -d '{
  "redisId": "string",
  "name": "string",
  "appName": "string",
  "description": "string",
  "databasePassword": "string",
  "dockerImage": "redis:8",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "externalPort": 0,
  "createdAt": "string",
  "applicationStatus": "idle",
  "projectId": "string"
}'

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

On this page