Redis

Redis create

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

name*string

Length1 <= length

appName?string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

databasePassword*string

dockerImage?string

Default"redis:8"

environmentId*string

description?string|null

serverId?string|null

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.create" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "databasePassword": "string",
    "environmentId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "databasePassword": "string",    "environmentId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis one

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

redisId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/redis.one?redisId=string"

curl -X GET "https://your-notploy-instance.com/api/redis.one?redisId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis start

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.start" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.start" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis reload

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

appName*string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.reload" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "appName": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.reload" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string",    "appName": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis stop

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.stop" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.stop" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis save External Port

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

externalPort*number|null

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.saveExternalPort" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "externalPort": 0
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.saveExternalPort" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string",    "externalPort": 0  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis deploy

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.deploy" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.deploy" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis change Status

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

applicationStatus*string

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

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.changeStatus" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "applicationStatus": "idle"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.changeStatus" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string",    "applicationStatus": "idle"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis remove

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.remove" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.remove" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis save Environment

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

env*string|null

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.saveEnvironment" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "env": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.saveEnvironment" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string",    "env": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis update

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Length1 <= length

name?string

Length1 <= length

appName?string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

description?string|null

databasePassword?string

dockerImage?string

command?string|null

args?|null

env?string|null

memoryReservation?string|null

memoryLimit?string|null

cpuReservation?string|null

cpuLimit?string|null

externalPort?number|null

createdAt?string

applicationStatus?string

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

healthCheckSwarm?|null

restartPolicySwarm?|null

placementSwarm?|null

updateConfigSwarm?|null

rollbackConfigSwarm?|null

modeSwarm?|null

labelsSwarm?|null

networkSwarm?|null

stopGracePeriodSwarm?number|null

endpointSpecSwarm?|null

ulimitsSwarm?|null

replicas?number

environmentId?string

networkIds?|null

detachNotployNetwork?boolean

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.update" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.update" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis change Password

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Length1 <= length

password*string

Match^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.changePassword" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "password": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.changePassword" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string",    "password": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis move

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

targetEnvironmentId*string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.move" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string",
    "targetEnvironmentId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.move" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string",    "targetEnvironmentId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis rebuild

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

redisId*string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/redis.rebuild" \
  -H "Content-Type: application/json" \
  -d '{
    "redisId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/redis.rebuild" \  -H "Content-Type: application/json" \  -d '{    "redisId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis search

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

q?string

name?string

appName?string

description?string

projectId?string

environmentId?string

limit?number

Default20

Range1 <= value <= 100

offset?number

Default0

Range0 <= value

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/redis.search"

curl -X GET "https://your-notploy-instance.com/api/redis.search"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Redis read Logs

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

redisId*string

Length1 <= length

tail?integer

Default100

Range1 <= value <= 10000

since?string

Default"all"

Match^(all|\d+[smhd])$

search?string

Match^[a-zA-Z0-9 ._-]{0,500}$

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/redis.readLogs?redisId=string"

curl -X GET "https://your-notploy-instance.com/api/redis.readLogs?redisId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`