Pipeline ports

Pipeline port

Port by ID.

GEThttps://cloud-api.calyptia.com/v1/pipeline_ports/{portID}

Authorization

userproject

Path parameters

portID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

protocol*string

Example: "tcp"

kind*PipelinePortKind (enum)

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

LoadBalancerClusterIPNodePort

frontendPort*integer (int32)

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

backendPort*integer (int32)

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

endpoint*string

pluginID*nullable string

Example: "forward.0"

pluginName*nullable string

Example: "forward"

pluginAlias*nullable string

Example: "myforwardinput"

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_ports/{portID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "protocol": "tcp",
  "kind": "LoadBalancer",
  "frontendPort": 0,
  "backendPort": 0,
  "endpoint": "text",
  "pluginID": "forward.0",
  "pluginName": "forward",
  "pluginAlias": "myforwardinput",
  "createdAt": "2025-01-22T20:52:33.562Z",
  "updatedAt": "2025-01-22T20:52:33.562Z"
}

Delete pipeline port

Delete port by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/pipeline_ports/{portID}

Authorization

userproject

Path parameters

portID*string (uuid)

Response

204

No Content

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_ports/{portID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update pipeline port

Update port by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/pipeline_ports/{portID}

Authorization

userproject

Path parameters

portID*string (uuid)

Body

application/json

protocolnullable string

Example: "tcp"

frontendPortnullable integer (int32)

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

backendPortnullable integer (int32)

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

endpointnullable string

Response

204

No Content

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_ports/{portID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();