Dokploy
Generated

Redis

POST
/redis.create

Redis create

/redis.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

appName
Required
string

Minimum length: 1

databasePassword
Required
string

dockerImagestring

Default: "redis:8"

projectId
Required
string

descriptionstring | null

serverIdstring | null

curl -X POST "http://your-dokploy-instance.com/api/redis.create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "appName": "string",
    "databasePassword": "string",
    "dockerImage": "redis:8",
    "projectId": "string",
    "description": "string",
    "serverId": "string"
  }'

Successful response

GET
/redis.one

Redis one

/redis.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

redisId
Required
string

curl -X GET "http://your-dokploy-instance.com/api/redis.one?redisId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/redis.start

Redis start

/redis.start

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/redis.start" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

Successful response

POST
/redis.reload

Redis reload

/redis.reload

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

appName
Required
string

Minimum length: 1
curl -X POST "http://your-dokploy-instance.com/api/redis.reload" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "appName": "string"
  }'

Successful response

POST
/redis.stop

Redis stop

/redis.stop

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/redis.stop" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

Successful response

POST
/redis.saveExternalPort

Redis save External Port

/redis.saveExternalPort

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

externalPort
Required
number | null

curl -X POST "http://your-dokploy-instance.com/api/redis.saveExternalPort" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "externalPort": 0
  }'

Successful response

POST
/redis.deploy

Redis deploy

/redis.deploy

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/redis.deploy" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

Successful response

POST
/redis.changeStatus

Redis change Status

/redis.changeStatus

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
curl -X POST "http://your-dokploy-instance.com/api/redis.changeStatus" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "applicationStatus": "idle"
  }'

Successful response

POST
/redis.remove

Redis remove

/redis.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/redis.remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

Successful response

POST
/redis.saveEnvironment

Redis save Environment

/redis.saveEnvironment

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

redisId
Required
string

envstring | null

curl -X POST "http://your-dokploy-instance.com/api/redis.saveEnvironment" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "env": "string"
  }'

Successful response

POST
/redis.update

Redis update

/redis.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

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

curl -X POST "http://your-dokploy-instance.com/api/redis.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -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"
  }'

Successful response

Previous

Redirects

Next

Registry