Pipeline ports

PreviousPipeline secrets NextConfig validate

Pipeline port

get

Port by ID.

Authorizations

Path parameters

portIDstring · uuidRequired

Responses

200

application/json

get

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

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-06-06T04:05:13.540Z",
  "updatedAt": "2025-06-06T04:05:13.540Z"
}

Delete pipeline port

delete

Delete port by its ID.

Authorizations

Path parameters

portIDstring · uuidRequired

Responses

204

No Content

delete

DELETE /v1/pipeline_ports/{portID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update pipeline port

patch

Update port by its ID.

Authorizations

Path parameters

portIDstring · uuidRequired

Body

Update pipeline port request body.

protocolstring | nullableOptionalDefault: nullExample: tcp

frontendPortinteger · int32 | nullableOptional

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

Default: null

backendPortinteger · int32 | nullableOptional

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

Default: null

endpointstring | nullableOptionalDefault: null

kindstring · enum | nullableOptionalDeprecated

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

Default: nullPossible values:

Responses

204

No Content

patch

PATCH /v1/pipeline_ports/{portID} 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"
}

204

No Content

No content