Dokploy

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

dockerImagestring

Default: "postgres:15"

projectId
Required
string

descriptionstring | null

Status codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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

envstring | null

Status codeDescription
200Successful response
defaultError 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 codeDescription
200Successful response
defaultError 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

namestring

Minimum length: 1

appNamestring

databaseNamestring

Minimum length: 1

databaseUserstring

Minimum length: 1

databasePasswordstring

descriptionstring | null

dockerImagestring

Default: "postgres:15"

commandstring | null

envstring | null

memoryReservationnumber | null

externalPortnumber | null

memoryLimitnumber | null

cpuReservationnumber | null

cpuLimitnumber | null

applicationStatusstring

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

createdAtstring

projectIdstring

Status codeDescription
200Successful response
defaultError 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"
    }
  ]
}

On this page