Port
Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
publishedPort*number
publishMode?string
Default
"ingress"Value in
"ingress" | "host"targetPort*number
protocol?string
Default
"tcp"Value in
"tcp" | "udp"applicationId*string
Length
1 <= length[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/port.create" \ -H "Content-Type: application/json" \ -d '{ "publishedPort": 0, "targetPort": 0, "applicationId": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Query Parameters
portId*string
Length
1 <= lengthResponse Body
application/json
application/json
curl -X GET "https://your-dokploy-instance.com/api/port.one?portId=string"{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
portId*string
Length
1 <= length[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/port.delete" \ -H "Content-Type: application/json" \ -d '{ "portId": "string" }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}Authorization
x-api-key x-api-key<token>
API key authentication. Use YOUR-GENERATED-API-KEY
In: header
Request Body
application/json
portId*string
Length
1 <= lengthpublishedPort*number
publishMode?string
Default
"ingress"Value in
"ingress" | "host"targetPort*number
protocol?string
Default
"tcp"Value in
"tcp" | "udp"[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://your-dokploy-instance.com/api/port.update" \ -H "Content-Type: application/json" \ -d '{ "portId": "string", "publishedPort": 0, "targetPort": 0 }'{}{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}