Postgres

POST

/postgres.create

Postgres create

Authorization

`Authorization`<token>

API key authentication using Authorization header

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

Pattern: "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$"

`dockerImage`string

Default: "postgres:15"

`environmentId`
Required
string

`description`string | null

`serverId`string | null

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

Successful response

{}

GET

/postgres.one

Postgres one

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Query Parameters

`postgresId`
Required
string

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

Successful response

{}

POST

/postgres.start

Postgres start

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

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

Successful response

{}

POST

/postgres.stop

Postgres stop

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

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

Successful response

{}

POST

/postgres.saveExternalPort

Postgres save External Port

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

`externalPort`
Required
number | null

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

Successful response

{}

POST

/postgres.deploy

Postgres deploy

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

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

Successful response

{}

POST

/postgres.changeStatus

Postgres change Status

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

`applicationStatus`
Required
string

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

curl -X POST "https://your-dokploy-instance.com/api/postgres.changeStatus" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "postgresId": "string",
    "applicationStatus": "idle"
  }'

Successful response

{}

POST

/postgres.remove

Postgres remove

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

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

Successful response

{}

POST

/postgres.saveEnvironment

Postgres save Environment

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

`env`string | null

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

Successful response

{}

POST

/postgres.reload

Postgres reload

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

`appName`
Required
string

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

Successful response

{}

POST

/postgres.update

Postgres update

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`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

Pattern: "^[a-zA-Z0-9@#%^&*()_+\\-=[\\]{}|;:,.<>?~`]*$"

`description`string | null

`dockerImage`string

Default: "postgres:15"

`command`string | null

`args`array<string> | null

`env`string | null

`memoryReservation`string | null

`externalPort`number | null

`memoryLimit`string | null

`cpuReservation`string | null

`cpuLimit`string | null

`applicationStatus`string

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

`healthCheckSwarm`object | null

`restartPolicySwarm`object | null

`placementSwarm`object | null

`updateConfigSwarm`object | null

`rollbackConfigSwarm`object | null

`modeSwarm`object | null

`labelsSwarm`object | null

`networkSwarm`array<object> | null

`stopGracePeriodSwarm`integer | null

`endpointSpecSwarm`object | null

`replicas`number

`createdAt`string

`environmentId`string

curl -X POST "https://your-dokploy-instance.com/api/postgres.update" \
  -H "Authorization: <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",
    "args": [
      "string"
    ],
    "env": "string",
    "memoryReservation": "string",
    "externalPort": 0,
    "memoryLimit": "string",
    "cpuReservation": "string",
    "cpuLimit": "string",
    "applicationStatus": "idle",
    "healthCheckSwarm": {
      "Test": [
        "string"
      ],
      "Interval": 0,
      "Timeout": 0,
      "StartPeriod": 0,
      "Retries": 0
    },
    "restartPolicySwarm": {
      "Condition": "string",
      "Delay": 0,
      "MaxAttempts": 0,
      "Window": 0
    },
    "placementSwarm": {
      "Constraints": [
        "string"
      ],
      "Preferences": [
        {
          "Spread": {
            "SpreadDescriptor": "string"
          }
        }
      ],
      "MaxReplicas": 0,
      "Platforms": [
        {
          "Architecture": "string",
          "OS": "string"
        }
      ]
    },
    "updateConfigSwarm": {
      "Parallelism": 0,
      "Delay": 0,
      "FailureAction": "string",
      "Monitor": 0,
      "MaxFailureRatio": 0,
      "Order": "string"
    },
    "rollbackConfigSwarm": {
      "Parallelism": 0,
      "Delay": 0,
      "FailureAction": "string",
      "Monitor": 0,
      "MaxFailureRatio": 0,
      "Order": "string"
    },
    "modeSwarm": {
      "Replicated": {
        "Replicas": 0
      },
      "Global": {},
      "ReplicatedJob": {
        "MaxConcurrent": 0,
        "TotalCompletions": 0
      },
      "GlobalJob": {}
    },
    "labelsSwarm": {
      "property1": "string",
      "property2": "string"
    },
    "networkSwarm": [
      {
        "Target": "string",
        "Aliases": [
          "string"
        ],
        "DriverOpts": {}
      }
    ],
    "stopGracePeriodSwarm": 0,
    "endpointSpecSwarm": {
      "Mode": "string",
      "Ports": [
        {
          "Protocol": "string",
          "TargetPort": 0,
          "PublishedPort": 0,
          "PublishMode": "string"
        }
      ]
    },
    "replicas": 0,
    "createdAt": "string",
    "environmentId": "string"
  }'

Successful response

{}

POST

/postgres.move

Postgres move

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

`targetEnvironmentId`
Required
string

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

Successful response

{}

POST

/postgres.rebuild

Postgres rebuild

Authorization

`Authorization`<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

`postgresId`
Required
string

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

Successful response

{}

Body

Authorization<token>

nameRequiredstring

appNameRequiredstring

databaseNameRequiredstring

databaseUserRequiredstring

databasePasswordRequiredstring

dockerImagestring

environmentIdRequiredstring

descriptionstring | null

serverIdstring | null

Response

TypeScript

Query

Authorization<token>

postgresIdRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

externalPortRequirednumber | null

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

applicationStatusRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

envstring | null

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

appNameRequiredstring

Response

TypeScript

Body

Authorization<token>

postgresIdRequiredstring

namestring

appNamestring

databaseNamestring

databaseUserstring

databasePasswordstring

descriptionstring | null

dockerImagestring

commandstring | null

argsarray<string> | null

envstring | null

memoryReservationstring | null

externalPortnumber | null

memoryLimitstring | null

cpuReservationstring | null

`Authorization`<token>

`name`
Required
string

`appName`
Required
string

`databaseName`
Required
string

`databaseUser`
Required
string

`databasePassword`
Required
string

`dockerImage`string

`environmentId`
Required
string

`description`string | null

`serverId`string | null

`Authorization`<token>

`postgresId`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`externalPort`
Required
number | null

`Authorization`<token>

`postgresId`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`applicationStatus`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`env`string | null

`Authorization`<token>

`postgresId`
Required
string

`appName`
Required
string

`Authorization`<token>

`postgresId`
Required
string

`name`string

`appName`string

`databaseName`string

`databaseUser`string

`databasePassword`string

`description`string | null

`dockerImage`string

`command`string | null

`args`array<string> | null

`env`string | null

`memoryReservation`string | null

`externalPort`number | null

`memoryLimit`string | null

`cpuReservation`string | null

`cpuLimit`string | null

`applicationStatus`string

`healthCheckSwarm`object | null

`restartPolicySwarm`object | null

`placementSwarm`object | null

`updateConfigSwarm`object | null

`rollbackConfigSwarm`object | null

`modeSwarm`object | null

`labelsSwarm`object | null

`networkSwarm`array<object> | null

`stopGracePeriodSwarm`integer | null

`endpointSpecSwarm`object | null

`replicas`number

`createdAt`string

`environmentId`string

`Authorization`<token>

`postgresId`
Required
string

`targetEnvironmentId`
Required
string