Dokploy
Generated

Port

POST
/port.create

Port create

/port.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

publishedPort
Required
number

publishModestring

Default: "ingress"Value in: "ingress" | "host"

targetPort
Required
number

protocolstring

Default: "tcp"Value in: "tcp" | "udp"

applicationId
Required
string

Minimum length: 1
curl -X POST "https://your-dokploy-instance.com/api/port.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "publishedPort": 0,
    "publishMode": "ingress",
    "targetPort": 0,
    "protocol": "tcp",
    "applicationId": "string"
  }'

Successful response

{}

GET
/port.one

Port one

/port.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

portId
Required
string

Minimum length: 1
curl -X GET "https://your-dokploy-instance.com/api/port.one?portId=string" \
  -H "Authorization: <token>"

Successful response

{}

POST
/port.delete

Port delete

/port.delete

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

portId
Required
string

Minimum length: 1
curl -X POST "https://your-dokploy-instance.com/api/port.delete" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "portId": "string"
  }'

Successful response

{}

POST
/port.update

Port update

/port.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

portId
Required
string

Minimum length: 1

publishedPort
Required
number

publishModestring

Default: "ingress"Value in: "ingress" | "host"

targetPort
Required
number

protocolstring

Default: "tcp"Value in: "tcp" | "udp"
curl -X POST "https://your-dokploy-instance.com/api/port.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "portId": "string",
    "publishedPort": 0,
    "publishMode": "ingress",
    "targetPort": 0,
    "protocol": "tcp"
  }'

Successful response

{}

Previous

Organization

Next

Postgres