PostgreSQL

Create PostgreSQL Database

curl -X POST "https://your-dokploy-instance.com/api/postgres.create" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Database",
    "appName": "prod-postgres",
    "databaseName": "myapp",
    "databaseUser": "admin",
    "databasePassword": "SecurePass123!",
    "dockerImage": "postgres:18",
    "environmentId": "env_123456",
    "description": "Main production PostgreSQL database"
  }'

string

required

Display name for the PostgreSQL database

string

required

Unique application name used for Docker container identification

string

required

Name of the database to create

string

required

Username for database access

string

required

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

string

required

ID of the environment where this database will be deployed

string

default:"postgres:18"

Docker image to use for PostgreSQL

string

Optional description of the database instance

string

Optional server ID for deployment on specific server

string

Unique identifier for the created PostgreSQL instance

string

Application name of the database

string

Display name of the database

Get PostgreSQL Database

curl -X GET "https://your-dokploy-instance.com/api/postgres.one?postgresId=pg_123456" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

string

required

ID of the PostgreSQL database to retrieve

string

Database identifier

string

Display name

string

Application name

string

Database name

string

Database username

string

PostgreSQL Docker image

string

Current status: idle, running, done, or error

number

External port for database access (if configured)

Deploy PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.deploy" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456"
  }'

string

required

ID of the PostgreSQL database to deploy

Start PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.start" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456"
  }'

string

required

ID of the PostgreSQL database to start

Stop PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.stop" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456"
  }'

string

required

ID of the PostgreSQL database to stop

Update PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.update" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456",
    "name": "Updated Database Name",
    "description": "Updated description",
    "memoryLimit": "2g",
    "memoryReservation": "1g",
    "cpuLimit": "1",
    "cpuReservation": "0.5"
  }'

string

required

ID of the PostgreSQL database to update

string

New display name

string

New description

string

Maximum memory (e.g., “2g”, “512m”)

string

Guaranteed memory allocation

string

Maximum CPU cores

string

Guaranteed CPU allocation

Save External Port

curl -X POST "https://your-dokploy-instance.com/api/postgres.saveExternalPort" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456",
    "externalPort": 5432
  }'

string

required

ID of the PostgreSQL database

number

Port number for external access. Set to null to remove external port.

Save Environment Variables

curl -X POST "https://your-dokploy-instance.com/api/postgres.saveEnvironment" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456",
    "env": "POSTGRES_MAX_CONNECTIONS=200\nPOSTGRES_SHARED_BUFFERS=256MB"
  }'

string

required

ID of the PostgreSQL database

string

Environment variables in KEY=VALUE format, separated by newlines

Reload PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.reload" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456",
    "appName": "prod-postgres"
  }'

string

required

ID of the PostgreSQL database

string

required

Application name of the database

Rebuild PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.rebuild" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456"
  }'

string

required

ID of the PostgreSQL database to rebuild

Remove PostgreSQL

curl -X POST "https://your-dokploy-instance.com/api/postgres.remove" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "pg_123456"
  }'

string

required

ID of the PostgreSQL database to remove

Connection String Format

postgresql://[databaseUser]:[databasePassword]@[appName]:5432/[databaseName]

Example:

postgresql://admin:SecurePass123!@prod-postgres:5432/myapp

For external connections:

postgresql://admin:SecurePass123!@your-server.com:5432/myapp

Getting Started

Applications

Databases

Docker

Projects & Deployments

Monitoring

Administration

Create PostgreSQL Database

Get PostgreSQL Database

Deploy PostgreSQL

Start PostgreSQL

Stop PostgreSQL

Update PostgreSQL

Save External Port

Save Environment Variables

Reload PostgreSQL

Rebuild PostgreSQL

Remove PostgreSQL

Connection String Format

​Create PostgreSQL Database

​Get PostgreSQL Database

​Deploy PostgreSQL

​Start PostgreSQL

​Stop PostgreSQL

​Update PostgreSQL

​Save External Port

​Save Environment Variables

​Reload PostgreSQL

​Rebuild PostgreSQL

​Remove PostgreSQL

​Connection String Format

Create PostgreSQL Database

Get PostgreSQL Database

Deploy PostgreSQL

Start PostgreSQL

Stop PostgreSQL

Update PostgreSQL

Save External Port

Save Environment Variables

Reload PostgreSQL

Rebuild PostgreSQL

Remove PostgreSQL

Connection String Format