Dokploy SDK

TypeScript SDK for the Dokploy API — auto-generated from the OpenAPI spec.

Installation

npm install @dokploy/sdk
# or
pnpm add @dokploy/sdk

Usage

import { client, applicationCreate, applicationOne, projectCreate } from "@dokploy/sdk";

// Configure the client with your Dokploy instance URL and API token
client.setConfig({
  baseUrl: "https://your-dokploy-instance.com/api",
  headers: {
    "x-api-key": "YOUR_API_TOKEN",
  },
});

Create a project

const { data, error } = await projectCreate({
  body: {
    name: "my-project",
    description: "My awesome project",
  },
});

Deploy an application

const { data, error } = await applicationCreate({
  body: {
    name: "my-app",
    projectId: "project-id",
  },
});

Fetch application details

const { data, error } = await applicationOne({
  query: { applicationId: "app-id" },
});

console.log(data?.name);

API Coverage

524 endpoints across the full Dokploy API:

Category	Resources
Apps	application, compose, docker
Databases	postgres, mysql, redis, mongo, mariadb
Infrastructure	server, cluster, swarm, registry
Networking	domain, port, redirects, certificates, sshRouter
Git	github, gitlab, gitbucket, gitea, gitProvider
Storage	mounts, backup, destination, volumeBackups
Platform	project, deployment, rollback, schedule, environment
System	admin, settings, security, user, organization, ai

Regenerating the SDK

If you update openapi.json, regenerate the SDK with:

pnpm generate

License

Apache 2.0