dokploy-api-cli

name	dokploy-api-cli
description	Use when operating a Dokploy-managed deployment via REST API from the shell — creating/updating/deploying postgres/redis/compose/application services, switching an application's source between docker registry and git build, or scripting redeploys. Covers auth, the working endpoint catalog, and a critical gotcha about deployment status semantics.

Dokploy API from the CLI

Operate Dokploy entirely from curl when the dashboard isn't practical (scripting, agents, headless ops).

Auth

Generate an API token in dashboard → Profile → API. Pass on every request:

-H "x-api-key: $TOKEN"

Other auth headers (Authorization: Bearer …) return 401 Unauthorized. There is no public OpenAPI/swagger endpoint — discover routes by probing.

Endpoint Catalog (verified)

All endpoints are under https://<dokploy-host>/api/<router>.<procedure>. Reads are GET with query params, writes are POST with JSON body.

Discovery

Endpoint	Notes
GET /api/project.all	List projects
GET /api/project.one?projectId=<id>	Project + nested environments[].{applications, mongo, postgres, redis, compose}
GET /api/postgres.one?postgresId=<id>	Includes appName (internal hostname), databasePassword, externalPort
GET /api/application.one?applicationId=<id>	Includes env (multiline string), sourceType, ,