Ports

Pipeline ports

get

Ports from a pipeline.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Query parameters

lastintegerOptional

Last ports.

Responses

application/json

object[]Optional

Pipeline port model.

get

HTTPcURLJavaScriptPython

GET /v1/aggregator_pipelines/{pipelineID}/ports HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "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-04-24T08:04:30.479Z",
    "updatedAt": "2025-04-24T08:04:30.479Z"
  }
]

Create pipeline port

post

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

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Body

Create pipeline port request body.

protocolstringRequiredExample: 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 · enumOptionalDeprecated

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

Default: LoadBalancerAvailable options:

Responses

application/json

objectOptional

Created pipeline port response body.

post

HTTPcURLJavaScriptPython

POST /v1/aggregator_pipelines/{pipelineID}/ports HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "protocol": "tcp",
  "frontendPort": 1,
  "backendPort": 1,
  "endpoint": "text"
}

201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "kind": "text",
  "pluginID": "forward.0",
  "pluginName": "forward",
  "pluginAlias": "myforwardinput",
  "createdAt": "2025-04-24T08:04:30.479Z"
}