https://github.com/dokploy/sdk
The Official SDK package for Dokploy
https://github.com/dokploy/sdk
dokploy sdk typescript vps
Last synced: about 1 month ago
JSON representation
The Official SDK package for Dokploy
- Host: GitHub
- URL: https://github.com/dokploy/sdk
- Owner: Dokploy
- License: mit
- Created: 2026-05-09T08:15:45.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-13T07:10:48.000Z (about 2 months ago)
- Last Synced: 2026-05-15T00:42:12.262Z (about 2 months ago)
- Topics: dokploy, sdk, typescript, vps
- Language: TypeScript
- Homepage: https://dokploy.com
- Size: 292 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Dokploy SDK
TypeScript SDK for the [Dokploy](https://dokploy.com) API — auto-generated from the OpenAPI spec.
## Installation
```bash
npm install @dokploy/sdk
# or
pnpm add @dokploy/sdk
```
## Usage
```ts
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
```ts
const { data, error } = await projectCreate({
body: {
name: "my-project",
description: "My awesome project",
},
});
```
### Deploy an application
```ts
const { data, error } = await applicationCreate({
body: {
name: "my-app",
projectId: "project-id",
},
});
```
### Fetch application details
```ts
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:
```bash
pnpm generate
```
## License
Apache 2.0