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 user API

The user API from Dokploy — 23 operation(s) for user.

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

Tagged areas include User. 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 23 operations across 23 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.

23 operations 23 paths 5 schemas 14 GET9 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 user 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 23

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

user 23
GET
/user.all
user-all → 200400401403404500
GET
/user.one
user-one 1 param → 200400401403404500
GET
/user.session
user-session → 200400401403404500
GET
/user.get
user-get → 200400401403404500
GET
/user.getPermissions
user-getPermissions → 200400401403404500
GET
/user.haveRootAccess
user-haveRootAccess → 200400401403404500
GET
/user.getBackups
user-getBackups → 200400401403404500
GET
/user.getServerMetrics
user-getServerMetrics → 200400401403404500
POST
/user.update
user-update body → 200400401403500
GET
/user.getUserByToken
user-getUserByToken 1 param → 200400401403404500
GET
/user.getMetricsToken
user-getMetricsToken → 200400401403404500
POST
/user.remove
user-remove body → 200400401403500
POST
/user.assignPermissions
user-assignPermissions body → 200400401403500
GET
/user.getInvitations
user-getInvitations → 200400401403404500
GET
/user.getContainerMetrics
user-getContainerMetrics 4 params → 200400401403404500
POST
/user.generateToken
user-generateToken → 200400401403500
POST
/user.deleteApiKey
user-deleteApiKey body → 200400401403500
POST
/user.createApiKey
user-createApiKey body → 200400401403500
GET
/user.checkUserOrganizations
user-checkUserOrganizations 1 param → 200400401403404500
POST
/user.createUserWithCredentials
user-createUserWithCredentials body → 200400401403500
POST
/user.sendInvitation
user-sendInvitation body → 200400401403500
GET
/user.getBookmarkedTemplates
user-getBookmarkedTemplates → 200400401403404500
POST
/user.toggleTemplateBookmark
user-toggleTemplateBookmark body → 200400401403500

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-user-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 compose API
Dokploy customRole API
Dokploy deployment API
Dokploy destination API
Where this information came from

This is an independent, third-party profile of Dokploy user 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.