Ports

Pipeline ports

Ports from a pipeline.

GEThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/ports

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

200

OK

Body

application/json

id*string (uuid)

protocol*string

frontendPort*integer (int32)

backendPort*integer (int32)

endpoint*string

pluginID*nullable string

pluginName*nullable string

pluginAlias*nullable string

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

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

Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "protocol": "tcp",
    "endpoint": "text",
    "pluginID": "forward.0",
    "pluginName": "forward",
    "pluginAlias": "myforwardinput",
    "createdAt": "2024-05-11T02:54:44.578Z",
    "updatedAt": "2024-05-11T02:54:44.578Z"
  }
]

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.

POSThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/ports

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

protocol*string

frontendPort*integer (int32)

backendPort*integer (int32)

endpoint*string

Response

201

Created

Body

application/json

id*string (uuid)

pluginID*nullable string

pluginName*nullable string

pluginAlias*nullable string

createdAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/ports', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "protocol": "tcp",
      "endpoint": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pluginID": "forward.0",
  "pluginName": "forward",
  "pluginAlias": "myforwardinput",
  "createdAt": "2024-05-11T02:54:44.578Z"
}