Pipeline ports

Pipeline port

Port by ID.

get

/v1/pipeline_ports/{portID}

Authorizations

userproject

Path parameters

portIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/pipeline_ports/{portID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "protocol": "tcp",
  "kind": "LoadBalancer",
  "frontendPort": 1,
  "backendPort": 1,
  "endpoint": "text",
  "pluginID": "forward.0",
  "pluginName": "forward",
  "pluginAlias": "myforwardinput",
  "createdAt": "2025-03-12T02:06:21.468Z",
  "updatedAt": "2025-03-12T02:06:21.468Z"
}

OK

Delete pipeline port

Delete port by its ID.

delete

/v1/pipeline_ports/{portID}

Authorizations

userproject

Path parameters

portIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/pipeline_ports/{portID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No Content

Update pipeline port

Update port by its ID.

patch

/v1/pipeline_ports/{portID}

Authorizations

userproject

Path parameters

portIDstring · uuidrequired

Body

protocolstring | nullable

Example: tcp

frontendPortinteger · int32 | nullable

FrontendPort is equivalent to Docker's host port and Kubernetes' service port. It should be unique within the pipeline.

backendPortinteger · int32 | nullable

BackendPort is equivalent to Docker's container port and Kubernetes' target port (pod).

endpointstring | nullable

kindstring · enum | nullableDeprecated

The kind/type of the service associated to this port.

Options: LoadBalancer, ClusterIP, NodePort

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/pipeline_ports/{portID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "protocol": "tcp",
    "frontendPort": null,
    "backendPort": null,
    "endpoint": null,
    "kind": null
  }'

204

204

No body

No Content