Pipeline ports
Port by ID.
Authorizations
Path parameters
portIDstring · uuidRequired
Responses
200
OK
application/json
get
GET /v1/pipeline_ports/{portID} 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-06-27T22:41:59.663Z",
"updatedAt": "2025-06-27T22:41:59.663Z"
}
Update port by its ID.
Authorizations
Path parameters
portIDstring · uuidRequired
Body
Update pipeline port request body.
protocolstring | nullableOptionalDefault:
null
Example: tcp
frontendPortinteger · int32 | nullableOptionalDefault:
FrontendPort is equivalent to Docker's host port and Kubernetes' service port. It should be unique within the pipeline.
null
backendPortinteger · int32 | nullableOptionalDefault:
BackendPort is equivalent to Docker's container port and Kubernetes' target port (pod).
null
endpointstring | nullableOptionalDefault:
null
kindstring · enum | nullableOptionalDeprecatedDefault:
The kind/type of the service associated to this port.
null
Possible 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