Ports

Pipeline ports

Ports from a pipeline.

get

/v1/aggregator_pipelines/{pipelineID}/ports

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Query parameters

lastinteger

Last ports.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/ports' \
  --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-12T04:26:33.012Z",
    "updatedAt": "2025-03-12T04:26:33.012Z"
  }
]

OK

Create pipeline port

Create port within a pipeline. Ports can automatically be parsed from a config file, but this action allows you to programatically add more.

post

/v1/aggregator_pipelines/{pipelineID}/ports

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Body

protocolstringrequired

Example: tcp

frontendPortinteger · int32required

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

backendPortinteger · int32required

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

endpointstringrequired

kindstring · enum · default: LoadBalancerDeprecated

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

Options: LoadBalancer, ClusterIP, NodePort

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/ports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "protocol": "tcp",
    "frontendPort": 1,
    "backendPort": 1,
    "endpoint": "text",
    "kind": "LoadBalancer"
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "kind": null,
  "pluginID": "forward.0",
  "pluginName": "forward",
  "pluginAlias": "myforwardinput",
  "createdAt": "2025-03-12T04:26:33.012Z"
}

Created