Dokploy

Postgres

POST
/postgres.create

Postgres create

/postgres.create

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

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

serverIdstring | null

curl -X POST "http://your-dokploy-instance.com/api/postgres.create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "appName": "string",
    "databaseName": "string",
    "databaseUser": "string",
    "databasePassword": "string",
    "dockerImage": "postgres:15",
    "projectId": "string",
    "description": "string",
    "serverId": "string"
  }'

Successful response

GET
/postgres.one

Postgres one

/postgres.one

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

postgresId
Required
string

curl -X GET "http://your-dokploy-instance.com/api/postgres.one?postgresId=string" \
  -H "Authorization: Bearer <token>"

Successful response

POST
/postgres.start

Postgres start

/postgres.start

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/postgres.start" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string"
  }'

Successful response

POST
/postgres.stop

Postgres stop

/postgres.stop

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/postgres.stop" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string"
  }'

Successful response

POST
/postgres.saveExternalPort

Postgres save External Port

/postgres.saveExternalPort

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

externalPort
Required
number | null

curl -X POST "http://your-dokploy-instance.com/api/postgres.saveExternalPort" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string",
    "externalPort": 0
  }'

Successful response

POST
/postgres.deploy

Postgres deploy

/postgres.deploy

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/postgres.deploy" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string"
  }'

Successful response

POST
/postgres.changeStatus

Postgres change Status

/postgres.changeStatus

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

applicationStatus
Required
string

Value in: "idle" | "running" | "done" | "error"
curl -X POST "http://your-dokploy-instance.com/api/postgres.changeStatus" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string",
    "applicationStatus": "idle"
  }'

Successful response

POST
/postgres.remove

Postgres remove

/postgres.remove

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

curl -X POST "http://your-dokploy-instance.com/api/postgres.remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string"
  }'

Successful response

POST
/postgres.saveEnvironment

Postgres save Environment

/postgres.saveEnvironment

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

envstring | null

curl -X POST "http://your-dokploy-instance.com/api/postgres.saveEnvironment" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string",
    "env": "string"
  }'

Successful response

POST
/postgres.reload

Postgres reload

/postgres.reload

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

postgresId
Required
string

appName
Required
string

curl -X POST "http://your-dokploy-instance.com/api/postgres.reload" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string",
    "appName": "string"
  }'

Successful response

POST
/postgres.update

Postgres update

/postgres.update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

application/jsonRequired

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

curl -X POST "http://your-dokploy-instance.com/api/postgres.update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -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"
  }'

Successful response

Previous

Port

Next

Project