LogoLogo
Support PortalCalyptia CoreContact Us
Calyptia Core API
Calyptia Core API
  • Specification
  • About
  • API reference
    • Verification email
    • Projects
      • Tokens
      • Members
      • Invite
      • Agents
      • Aggregators
      • Core instances
      • Aggregator pipelines
      • Pipelines
      • Environments
      • Metrics
      • Config sections
      • Fleets
        • Status
      • Aws contracts
      • Processing rule templates
      • Saml mappings
    • Project tokens
    • Members
    • Join project
    • Agents
      • Config history
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
      • Errors
    • Aggregators
      • Ping
      • Resource profiles
      • Pipelines
      • Pipelines metrics
    • Core instance files
    • Core instance secrets
    • Resource profiles
    • Aggregator pipelines
      • Config history
      • Status history
      • Files
      • Secrets
      • Ports
    • Pipeline files
    • Pipeline logs
    • Pipeline checks
    • Core instance checks
    • Ingest checks
    • Pipeline secrets
    • Pipeline ports
    • Config validate
    • Config validate v2
    • Environments
    • Pipeline metrics
    • Aggregator metrics
    • Cluster objects
    • Trace sessions
      • Records
    • Config sections
    • Processing rules
    • Preview processing rule
    • Fleets
      • Status
      • Config
      • Files
      • Agent errors
    • Fleet files
    • Search
    • Aws customer redirect
    • Cluster object regexes
    • Processing rule templates
    • Validate fluentbit config
    • Saml mappings
    • Core instances
      • Files
      • Secrets
      • Pipelines
      • Ingest checks
      • Checks
      • Cluster objects
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
    • Pipelines
      • Logs
      • Checks
      • Cluster objects
      • Metadata
      • Trace sessions
      • Trace session
        • Records
      • Config section set
      • Processing rules
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
      • Cluster object regexes
    • Agent errors
      • Dismiss
  • Specification
Powered by GitBook
On this page
  1. API reference
  2. Aggregator pipelines

Ports

PreviousSecretsNextPipeline files
  • GETPipeline ports
  • POSTCreate pipeline port

Pipeline ports

get

Ports from a pipeline.

Authorizations
Path parameters
pipelineIDstring · uuidRequired
Query parameters
lastintegerOptional

Last ports.

Responses
200
OK
application/json
get
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-05-09T09:17:11.651Z",
    "updatedAt": "2025-05-09T09:17:11.651Z"
  }
]

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
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: LoadBalancerPossible values:
Responses
201
Created
application/json
post
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-05-09T09:17:11.651Z"
}