How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dokploy compose API

The compose API from Dokploy — 31 operation(s) for compose.

Dokploy compose API is one of 48 APIs that Dokploy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Compose. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and rate-limit docs.

This API exposes 31 operations across 31 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://your-dokploy-instance.com/api.

31 operations 31 paths 5 schemas 9 GET22 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://your-dokploy-instance.com/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Dokploy compose API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey). By default, every request must be authenticated.

  • apiKey — API key authentication. Generate an API key from your Dokploy dashboard under Settings API Keys.

Paths & Operations 31

Across 31 paths, the API surfaces 31 operations — 9 GET, 22 POST. Each is listed below with its method, path, parameters, and response codes.

compose 31
POST
/compose.create
compose-create body → 200400401403500
GET
/compose.one
compose-one 1 param → 200400401403404500
POST
/compose.update
compose-update body → 200400401403500
POST
/compose.saveEnvironment
compose-saveEnvironment body → 200400401403500
POST
/compose.delete
compose-delete body → 200400401403500
POST
/compose.cleanQueues
compose-cleanQueues body → 200400401403500
POST
/compose.clearDeployments
compose-clearDeployments body → 200400401403500
POST
/compose.killBuild
compose-killBuild body → 200400401403500
GET
/compose.loadServices
compose-loadServices 2 params → 200400401403404500
GET
/compose.loadMountsByService
compose-loadMountsByService 2 params → 200400401403404500
POST
/compose.fetchSourceType
compose-fetchSourceType body → 200400401403500
POST
/compose.randomizeCompose
compose-randomizeCompose body → 200400401403500
POST
/compose.isolatedDeployment
compose-isolatedDeployment body → 200400401403500
GET
/compose.getConvertedCompose
compose-getConvertedCompose 1 param → 200400401403404500
POST
/compose.deploy
compose-deploy body → 200400401403500
POST
/compose.redeploy
compose-redeploy body → 200400401403500
POST
/compose.stop
compose-stop body → 200400401403500
POST
/compose.start
compose-start body → 200400401403500
GET
/compose.getDefaultCommand
compose-getDefaultCommand 1 param → 200400401403404500
POST
/compose.refreshToken
compose-refreshToken body → 200400401403500
POST
/compose.deployTemplate
compose-deployTemplate body → 200400401403500
GET
/compose.templates
compose-templates 1 param → 200400401403404500
GET
/compose.getTags
compose-getTags 1 param → 200400401403404500
POST
/compose.disconnectGitProvider
compose-disconnectGitProvider body → 200400401403500
POST
/compose.move
compose-move body → 200400401403500
POST
/compose.processTemplate
compose-processTemplate body → 200400401403500
POST
/compose.previewTemplate
compose-previewTemplate body → 200400401403500
POST
/compose.import
compose-import body → 200400401403500
POST
/compose.cancelDeployment
compose-cancelDeployment body → 200400401403500
GET
/compose.search
compose-search 8 params → 200400401403404500
GET
/compose.readLogs
compose-readLogs 5 params → 200400401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are error.BAD_REQUEST (3 properties), error.UNAUTHORIZED (3 properties), error.FORBIDDEN (3 properties), error.INTERNAL_SERVER_ERROR (3 properties). Each schema is shown below with its type and property counts.

error.NOT_FOUND
object
The error information
3 properties 2 required
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties 2 required
error.FORBIDDEN
object
The error information
3 properties 2 required
error.UNAUTHORIZED
object
The error information
3 properties 2 required
error.BAD_REQUEST
object
The error information
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dokploy-compose-api-openapi.yml Raw ↑

Other APIs Dokploy publishes across the network.

Dokploy admin API
Dokploy ai API
Dokploy application API
Dokploy auditLog API
Dokploy backup API
Dokploy bitbucket API
Dokploy certificates API
Dokploy cluster API
Dokploy customRole API
Dokploy deployment API
Dokploy destination API
Dokploy docker API
Where this information came from

This is an independent, third-party profile of Dokploy compose API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.