port

POST`/port.create`

port-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`publishedPort`
Required
number

`targetPort`
Required
number

`protocol`string

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

`applicationId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/port.create" \
  -d '{
  "publishedPort": 0,
  "targetPort": 0,
  "protocol": "tcp",
  "applicationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET`/port.one`

port-one

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`portId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/port.one?portId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/port.delete`

port-delete

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`portId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/port.delete" \
  -d '{
  "portId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/port.update`

port-update

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`portId`
Required
string

Minimum length: 1

`publishedPort`
Required
number

`targetPort`
Required
number

`protocol`string

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

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/port.update" \
  -d '{
  "portId": "string",
  "publishedPort": 0,
  "targetPort": 0,
  "protocol": "tcp"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

port

POST/port.create

AuthorizationRequiredBearer <token>

publishedPortRequirednumber

targetPortRequirednumber

protocolstring

applicationIdRequiredstring

Response

Typescript

GET/port.one

AuthorizationRequiredBearer <token>

portIdRequiredstring

Response

Typescript

POST/port.delete

AuthorizationRequiredBearer <token>

portIdRequiredstring

Response

Typescript

POST/port.update

AuthorizationRequiredBearer <token>

portIdRequiredstring

publishedPortRequirednumber

targetPortRequirednumber

protocolstring

Response

Typescript

On this page

POST`/port.create`

`Authorization`
Required
Bearer <token>

`publishedPort`
Required
number

`targetPort`
Required
number

`protocol`string

`applicationId`
Required
string

GET`/port.one`

`Authorization`
Required
Bearer <token>

`portId`
Required
string

POST`/port.delete`

`Authorization`
Required
Bearer <token>

`portId`
Required
string

POST`/port.update`

`Authorization`
Required
Bearer <token>

`portId`
Required
string

`publishedPort`
Required
number

`targetPort`
Required
number

`protocol`string