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

`dockerImage`string

Default: "redis:8"

`projectId`
Required
string

`description`string | null

Status code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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

`env`string | null

Status code	Description
`200`	Successful response
`default`	Error 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

`name`string

Minimum length: 1

`appName`string

Minimum length: 1

`description`string | null

`databasePassword`string

`dockerImage`string

Default: "redis:8"

`command`string | null

`env`string | null

`memoryReservation`number | null

`memoryLimit`number | null

`cpuReservation`number | null

`cpuLimit`number | null

`externalPort`number | null

`createdAt`string

`applicationStatus`string

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

`projectId`string

Status code	Description
`200`	Successful response
`default`	Error 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"
    }
  ]
}

redis

POST/redis.create

AuthorizationRequiredBearer <token>

nameRequiredstring

appNameRequiredstring

databasePasswordRequiredstring

dockerImagestring

projectIdRequiredstring

descriptionstring | null

Response

Typescript

GET/redis.one

AuthorizationRequiredBearer <token>

redisIdRequiredstring

Response

Typescript

POST/redis.start

AuthorizationRequiredBearer <token>

redisIdRequiredstring

Response

Typescript

POST/redis.reload

AuthorizationRequiredBearer <token>

redisIdRequiredstring

appNameRequiredstring

Response

Typescript

POST/redis.stop

AuthorizationRequiredBearer <token>

redisIdRequiredstring

Response

Typescript

POST/redis.saveExternalPort

AuthorizationRequiredBearer <token>

redisIdRequiredstring

externalPortRequirednumber | null

Response

Typescript

POST/redis.deploy

AuthorizationRequiredBearer <token>

redisIdRequiredstring

Response

Typescript

POST/redis.changeStatus

AuthorizationRequiredBearer <token>

redisIdRequiredstring

applicationStatusRequiredstring

Response

Typescript

POST/redis.remove

AuthorizationRequiredBearer <token>

redisIdRequiredstring

Response

Typescript

POST/redis.saveEnvironment

AuthorizationRequiredBearer <token>

redisIdRequiredstring

envstring | null

Response

Typescript

POST/redis.update

AuthorizationRequiredBearer <token>

redisIdRequiredstring

namestring

appNamestring

descriptionstring | null

databasePasswordstring

dockerImagestring

commandstring | null

envstring | null

memoryReservationnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

externalPortnumber | null

createdAtstring

applicationStatusstring

projectIdstring

Response

Typescript

POST`/redis.create`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`appName`
Required
string

`databasePassword`
Required
string

`dockerImage`string

`projectId`
Required
string

`description`string | null

GET`/redis.one`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

POST`/redis.start`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

POST`/redis.reload`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

`appName`
Required
string

POST`/redis.stop`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

POST`/redis.saveExternalPort`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

`externalPort`
Required
number | null

POST`/redis.deploy`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

POST`/redis.changeStatus`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

`applicationStatus`
Required
string

POST`/redis.remove`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

POST`/redis.saveEnvironment`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

`env`string | null

POST`/redis.update`

`Authorization`
Required
Bearer <token>

`redisId`
Required
string

`name`string

`appName`string

`description`string | null

`databasePassword`string

`dockerImage`string

`command`string | null

`env`string | null

`memoryReservation`number | null

`memoryLimit`number | null

`cpuReservation`number | null

`cpuLimit`number | null

`externalPort`number | null

`createdAt`string

`applicationStatus`string

`projectId`string