dokploy-api-cli

Manage Dokploy deployments via REST API from shell scripts.

61|1|Updated Apr 2, 2026
One-click install
npx skills add https://github.com/Innei/SKILL --skill dokploy-api-cli
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dokploy-api-cli
Source: https://github.com/Innei/SKILL/tree/main/skills/infrastructure/dokploy-api-cli
Command: npx skills add https://github.com/Innei/SKILL --skill dokploy-api-cli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Operate Dokploy deployments from the shell using REST API to automate creation, updates, and redeploys, avoiding the dashboard when headless scripting is required.

Core Features & Use Cases

  • Authenticate with an API token and pass it via the x-api-key header for every request.
  • Discover endpoints and perform operations across projects, environments, and services (postgres, redis, compose, and applications).
  • Script deployment lifecycles, switch application sources between docker registry and git builds, and handle auth, catalogs, and deployment status semantics.

Quick Start

Obtain an API token and begin issuing REST calls to manage Dokploy deployments from shell scripts.

Frequently Asked Questions about dokploy-api-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Dokploy deployments from the shell?

You can automate Dokploy deployments from the shell by issuing REST API requests to handle creation, updates, and redeploys. This method bypasses the dashboard, enabling headless scripting workflows for applications and services.

How does authentication work for the Dokploy REST API?

Authentication for the Dokploy REST API works by passing an API token as the x-api-key header in every request. You must obtain this token first to authorize shell scripts managing your deployments.

Can I manage postgres and redis services in Dokploy via API?

Yes, you can manage postgres, redis, compose, and applications across environments via the Dokploy API. It supports endpoint discovery and service stack operations within your projects and environments.

What HTTP methods does the Dokploy API use for mutations and reads?

The Dokploy API uses GET for reads and POST for mutations against endpoints under /api/<router>.<procedure>. This structure allows shell scripts to query deployment status and trigger service updates.

Do I need a dashboard to switch application sources between git and docker registry?

No, you do not need the dashboard to switch application sources. You can script deployment lifecycles and switch sources between docker registry and git builds directly using Dokploy REST API calls.

What's the best way to script Dokploy environment and project lifecycles?

The best way to script Dokploy project and environment lifecycles is using REST API calls from the shell. This enables automated handling of auth, endpoint discovery, and service stacks without manual dashboard interaction.