{"id":49781431,"url":"https://github.com/dokploy/sdk","last_synced_at":"2026-05-16T01:01:30.028Z","repository":{"id":356692960,"uuid":"1233679783","full_name":"Dokploy/sdk","owner":"Dokploy","description":"The Official SDK package for Dokploy","archived":false,"fork":false,"pushed_at":"2026-05-13T07:10:48.000Z","size":299,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-15T00:42:12.262Z","etag":null,"topics":["dokploy","sdk","typescript","vps"],"latest_commit_sha":null,"homepage":"https://dokploy.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dokploy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-09T08:15:45.000Z","updated_at":"2026-05-13T07:10:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Dokploy/sdk","commit_stats":null,"previous_names":["dokploy/sdk"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Dokploy/sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dokploy%2Fsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dokploy%2Fsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dokploy%2Fsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dokploy%2Fsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dokploy","download_url":"https://codeload.github.com/Dokploy/sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dokploy%2Fsdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33086737,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T20:25:35.270Z","status":"ssl_error","status_checked_at":"2026-05-15T20:25:34.732Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dokploy","sdk","typescript","vps"],"created_at":"2026-05-11T21:00:58.507Z","updated_at":"2026-05-16T01:01:27.985Z","avatar_url":"https://github.com/Dokploy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dokploy SDK\n\nTypeScript SDK for the [Dokploy](https://dokploy.com) API — auto-generated from the OpenAPI spec.\n\n## Installation\n\n```bash\nnpm install @dokploy/sdk\n# or\npnpm add @dokploy/sdk\n```\n\n## Usage\n\n```ts\nimport { client, applicationCreate, applicationOne, projectCreate } from \"@dokploy/sdk\";\n\n// Configure the client with your Dokploy instance URL and API token\nclient.setConfig({\n  baseUrl: \"https://your-dokploy-instance.com/api\",\n  headers: {\n    \"x-api-key\": \"YOUR_API_TOKEN\",\n  },\n});\n```\n\n### Create a project\n\n```ts\nconst { data, error } = await projectCreate({\n  body: {\n    name: \"my-project\",\n    description: \"My awesome project\",\n  },\n});\n```\n\n### Deploy an application\n\n```ts\nconst { data, error } = await applicationCreate({\n  body: {\n    name: \"my-app\",\n    projectId: \"project-id\",\n  },\n});\n```\n\n### Fetch application details\n\n```ts\nconst { data, error } = await applicationOne({\n  query: { applicationId: \"app-id\" },\n});\n\nconsole.log(data?.name);\n```\n\n## API Coverage\n\n524 endpoints across the full Dokploy API:\n\n| Category | Resources |\n|---|---|\n| Apps | `application`, `compose`, `docker` |\n| Databases | `postgres`, `mysql`, `redis`, `mongo`, `mariadb` |\n| Infrastructure | `server`, `cluster`, `swarm`, `registry` |\n| Networking | `domain`, `port`, `redirects`, `certificates`, `sshRouter` |\n| Git | `github`, `gitlab`, `gitbucket`, `gitea`, `gitProvider` |\n| Storage | `mounts`, `backup`, `destination`, `volumeBackups` |\n| Platform | `project`, `deployment`, `rollback`, `schedule`, `environment` |\n| System | `admin`, `settings`, `security`, `user`, `organization`, `ai` |\n\n## Regenerating the SDK\n\nIf you update `openapi.json`, regenerate the SDK with:\n\n```bash\npnpm generate\n```\n\n## License\n\nApache 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokploy%2Fsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdokploy%2Fsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokploy%2Fsdk/lists"}