---
title: "POST /redis.deploy"
method: POST
path: "/redis.deploy"
tags: ["redis"]
---

# POST /redis.deploy

`POST /redis.deploy`

## Request body

- object
  - `redisId` string, required

## Response `200`

Successful response

- object
  - `appName` string, required
  - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
  - `command` string, nullable, required
  - `cpuLimit` string, nullable, required
  - `cpuReservation` string, nullable, required
  - `createdAt` string, required
  - `databasePassword` string, required
  - `description` string, nullable, required
  - `dockerImage` string, required
  - `env` string, nullable, required
  - `environment` object, required
    - `createdAt` string, required
    - `description` string, nullable, required
    - `env` string, required
    - `environmentId` string, required
    - `name` string, required
    - `project` object, required
      - `createdAt` string, required
      - `description` string, nullable, required
      - `env` string, required
      - `name` string, required
      - `organizationId` string, required
      - `projectId` string, required
    - `projectId` string, required
  - `environmentId` string, required
  - `externalPort` number, nullable, required
  - `healthCheckSwarm` object, nullable, required
    - `Interval` number
    - `Retries` number
    - `StartPeriod` number
    - `Test` string[]
    - `Timeout` number
  - `labelsSwarm` object, nullable, required
  - `memoryLimit` string, nullable, required
  - `memoryReservation` string, nullable, required
  - `modeSwarm` object, nullable, required
    - `Global` object
    - `GlobalJob` object
    - `Replicated` object
      - `Replicas` number
    - `ReplicatedJob` object
      - `MaxConcurrent` number
      - `TotalCompletions` number
  - `mounts` object[], required
    - `applicationId` string, nullable, required
    - `composeId` string, nullable, required
    - `content` string, nullable, required
    - `filePath` string, nullable, required
    - `hostPath` string, nullable, required
    - `mariadbId` string, nullable, required
    - `mongoId` string, nullable, required
    - `mountId` string, required
    - `mountPath` string, required
    - `mysqlId` string, nullable, required
    - `postgresId` string, nullable, required
    - `redisId` string, nullable, required
    - `serviceType` 'application' | 'postgres' | 'mysql' | 'mariadb' | 'mongo' | 'redis' | 'compose', required
    - `type` 'bind' | 'volume' | 'file', required
    - `volumeName` string, nullable, required
  - `name` string, required
  - `networkSwarm` object[], nullable, required
    - `Aliases` string[]
    - `DriverOpts` object
    - `Target` string
  - `placementSwarm` object, nullable, required
    - `Constraints` string[]
    - `MaxReplicas` number
    - `Platforms` object[]
      - `Architecture` string, required
      - `OS` string, required
    - `Preferences` object[]
      - `Spread` object, required
        - `SpreadDescriptor` string, required
  - `redisId` string, required
  - `replicas` number, required
  - `restartPolicySwarm` object, nullable, required
    - `Condition` string
    - `Delay` number
    - `MaxAttempts` number
    - `Window` number
  - `rollbackConfigSwarm` object, nullable, required
    - `Delay` number
    - `FailureAction` string
    - `MaxFailureRatio` number
    - `Monitor` number
    - `Order` string, required
    - `Parallelism` number, required
  - `server` object, nullable, required
    - `appName` string, required
    - `command` string, required
    - `createdAt` string, required
    - `description` string, nullable, required
    - `enableDockerCleanup` boolean, required
    - `ipAddress` string, required
    - `metricsConfig` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `name` string, required
    - `organizationId` string, required
    - `port` number, required
    - `serverId` string, required
    - `serverStatus` 'active' | 'inactive', required
    - `sshKeyId` string, nullable, required
    - `username` string, required
  - `serverId` string, nullable, required
  - `updateConfigSwarm` object, nullable, required
    - `Delay` number
    - `FailureAction` string
    - `MaxFailureRatio` number
    - `Monitor` number
    - `Order` string, required
    - `Parallelism` number, required

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/charliedevelops/apis/dokploy-api.md) · [All operations](https://skmtc.net/charliedevelops/apis/dokploy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charliedevelops/dokploy-api/versions/50e2e470fdd0/schema)