postgres

POST`/postgres.create`

postgres-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`name`
Required
string

Minimum length: 1

`appName`
Required
string

`databaseName`
Required
string

Minimum length: 1

`databaseUser`
Required
string

Minimum length: 1

`databasePassword`
Required
string

`dockerImage`string

Default: "postgres:15"

`projectId`
Required
string

`description`string | null

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.create" \
  -d '{
  "name": "string",
  "appName": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "dockerImage": "postgres:15",
  "projectId": "string",
  "description": "string"
}'

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

GET`/postgres.one`

postgres-one

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`postgresId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/postgres.one?postgresId=string"

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

POST`/postgres.start`

postgres-start

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.start" \
  -d '{
  "postgresId": "string"
}'

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

POST`/postgres.stop`

postgres-stop

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.stop" \
  -d '{
  "postgresId": "string"
}'

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

POST`/postgres.saveExternalPort`

postgres-saveExternalPort

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

`externalPort`
Required
number | null

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.saveExternalPort" \
  -d '{
  "postgresId": "string",
  "externalPort": 0
}'

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

POST`/postgres.deploy`

postgres-deploy

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.deploy" \
  -d '{
  "postgresId": "string"
}'

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

POST`/postgres.changeStatus`

postgres-changeStatus

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
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/postgres.changeStatus" \
  -d '{
  "postgresId": "string",
  "applicationStatus": "idle"
}'

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

POST`/postgres.remove`

postgres-remove

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.remove" \
  -d '{
  "postgresId": "string"
}'

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

POST`/postgres.saveEnvironment`

postgres-saveEnvironment

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

`env`string | null

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.saveEnvironment" \
  -d '{
  "postgresId": "string",
  "env": "string"
}'

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

POST`/postgres.reload`

postgres-reload

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

`appName`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.reload" \
  -d '{
  "postgresId": "string",
  "appName": "string"
}'

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

POST`/postgres.update`

postgres-update

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`postgresId`
Required
string

Minimum length: 1

`name`string

Minimum length: 1

`appName`string

`databaseName`string

Minimum length: 1

`databaseUser`string

Minimum length: 1

`databasePassword`string

`description`string | null

`dockerImage`string

Default: "postgres:15"

`command`string | null

`env`string | null

`memoryReservation`number | null

`externalPort`number | null

`memoryLimit`number | null

`cpuReservation`number | null

`cpuLimit`number | null

`applicationStatus`string

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

`createdAt`string

`projectId`string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/postgres.update" \
  -d '{
  "postgresId": "string",
  "name": "string",
  "appName": "string",
  "databaseName": "string",
  "databaseUser": "string",
  "databasePassword": "string",
  "description": "string",
  "dockerImage": "postgres:15",
  "command": "string",
  "env": "string",
  "memoryReservation": 0,
  "externalPort": 0,
  "memoryLimit": 0,
  "cpuReservation": 0,
  "cpuLimit": 0,
  "applicationStatus": "idle",
  "createdAt": "string",
  "projectId": "string"
}'

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

postgres

POST/postgres.create

AuthorizationRequiredBearer <token>

nameRequiredstring

appNameRequiredstring

databaseNameRequiredstring

databaseUserRequiredstring

databasePasswordRequiredstring

dockerImagestring

projectIdRequiredstring

descriptionstring | null

Response

Typescript

GET/postgres.one

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

Response

Typescript

POST/postgres.start

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

Response

Typescript

POST/postgres.stop

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

Response

Typescript

POST/postgres.saveExternalPort

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

externalPortRequirednumber | null

Response

Typescript

POST/postgres.deploy

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

Response

Typescript

POST/postgres.changeStatus

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

applicationStatusRequiredstring

Response

Typescript

POST/postgres.remove

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

Response

Typescript

POST/postgres.saveEnvironment

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

envstring | null

Response

Typescript

POST/postgres.reload

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

appNameRequiredstring

Response

Typescript

POST/postgres.update

AuthorizationRequiredBearer <token>

postgresIdRequiredstring

namestring

appNamestring

databaseNamestring

databaseUserstring

databasePasswordstring

descriptionstring | null

dockerImagestring

commandstring | null

envstring | null

memoryReservationnumber | null

externalPortnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

applicationStatusstring

POST`/postgres.create`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`appName`
Required
string

`databaseName`
Required
string

`databaseUser`
Required
string

`databasePassword`
Required
string

`dockerImage`string

`projectId`
Required
string

`description`string | null

GET`/postgres.one`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

POST`/postgres.start`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

POST`/postgres.stop`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

POST`/postgres.saveExternalPort`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

`externalPort`
Required
number | null

POST`/postgres.deploy`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

POST`/postgres.changeStatus`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

`applicationStatus`
Required
string

POST`/postgres.remove`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

POST`/postgres.saveEnvironment`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

`env`string | null

POST`/postgres.reload`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

`appName`
Required
string

POST`/postgres.update`

`Authorization`
Required
Bearer <token>

`postgresId`
Required
string

`name`string

`appName`string

`databaseName`string

`databaseUser`string

`databasePassword`string

`description`string | null

`dockerImage`string

`command`string | null

`env`string | null

`memoryReservation`number | null

`externalPort`number | null

`memoryLimit`number | null

`cpuReservation`number | null

`cpuLimit`number | null

`applicationStatus`string

`createdAt`string

`projectId`string