Dokploy API
In some cases, you may need to interact directly with the dokploy API. Here's how both administrators and users can do this.
For Administrators
- Access the Swagger UI by navigating to
your-vps-ip:3000/swagger
. - Use the Swagger interface to interact with the API.
- By default, access to the Swagger UI is restricted, and only authenticated administrators can access the API.
For Users
- By default, users do not have direct access to the API.
- Administrators can grant users access to:
- Generate access tokens
- Access the Swagger UI
- If you need access, contact your administrator.
Note: The API provides advanced functionalities. Make sure you understand the operations you're performing to avoid unintended changes to the system.
Usage
By default the OpenApi base url is http://localhost:3000/api
, you need to replace with the ip of your dokploy instance or the domain name.
Authentication
The API uses JWT tokens for authentication. You can generate a token by going to the /settings/profile
page and go to API/CLI Section and generate the token.
Let's take a example of authenticated request:
then you will get the something like this: