Aggregator pipelines

Pipeline

Pipeline by ID.

get

/v1/aggregator_pipelines/{pipelineID}

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Query parameters

config_formatstring · enum

Desired output config format.

Options: ini, json, yaml

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-pipeline",
  "kind": "deployment",
  "config": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "rawConfig": "text",
    "configFormat": "ini",
    "createdAt": "2025-03-12T04:25:20.116Z"
  },
  "configSections": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": null,
      "kind": "input",
      "properties": [
        {
          "key": "name",
          "value": "dummy"
        }
      ],
      "createdAt": "2025-03-12T04:25:20.116Z",
      "updatedAt": "2025-03-12T04:25:20.116Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2025-03-12T04:25:20.116Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2025-03-12T04:25:20.116Z"
      }
    ],
    "createdAt": "2025-03-12T04:25:20.116Z"
  },
  "resourceProfile": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-resource-profile",
    "storageMaxChunksUp": 1,
    "storageSyncFull": true,
    "storageBacklogMemLimit": "1Mi",
    "storageVolumeSize": "2Mi",
    "storageMaxChunksPause": true,
    "cpuBufferWorkers": 1,
    "cpuLimit": "3Mi",
    "cpuRequest": "4Mi",
    "memoryLimit": "5Mi",
    "memoryRequest": "6Mi",
    "createdAt": "2025-03-12T04:25:20.116Z",
    "updatedAt": "2025-03-12T04:25:20.116Z"
  },
  "deploymentStrategy": "rollingupdate",
  "tracingEnabled": false,
  "waitForChecksBeforeDeploying": false,
  "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
  "replicasCount": 1,
  "replicasCountPrev": 1,
  "checksTotal": 1,
  "checksOK": 1,
  "checksRunning": 1,
  "tags": null,
  "metadata": null,
  "secrets": null,
  "files": null,
  "ports": null,
  "minReplicas": 1,
  "maxReplicas": 1,
  "scaleUpType": "Unknown",
  "scaleUpValue": 1,
  "scaleUpPeriodSeconds": 1,
  "scaleDownType": "Unknown",
  "scaleDownValue": 1,
  "scaleDownPeriodSeconds": 1,
  "utilizationCPUAverage": 1,
  "utilizationMemoryAverage": 1,
  "portKind": "LoadBalancer",
  "labels": null,
  "createdAt": "2025-03-12T04:25:20.116Z",
  "updatedAt": "2025-03-12T04:25:20.116Z"
}

OK

Delete pipeline

Delete pipeline by its ID.

delete

/v1/aggregator_pipelines/{pipelineID}

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No Content

Update pipeline

Update pipeline by its ID.

patch

/v1/aggregator_pipelines/{pipelineID}

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Body

namestring | nullable

DNS label format as of defined on RFC1123

Example: new-pipeline

kindstring · enum · default: deployment

Kind of deployment used when deploying this pipeline

Options: daemonSet, deployment

deploymentStrategystring · enum · default: rollingupdate

The deployment strategy to use when creating or updating changes to this pipeline.

Options: rollingupdate, hotReload

replicasCountinteger | nullable

rawConfigstring | nullable

configFormatstring · enum | nullable

Options: ini, json, yaml

imagestring | nullable

Example: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2

secretsobject[] | nullable

Update pipeline secret request body.

filesobject[] | nullable

Update pipeline file request body.

resourceProfilestring | nullable

Example: my-resource-profile

noAutoCreateEndpointsFromConfigboolean | nullable

noAutoCreateChecksFromConfigboolean | nullable

autoCreatePortsFromConfigboolean | nullableDeprecated

autoCreateChecksFromConfigboolean | nullableDeprecated

skipConfigValidationboolean · default: false

checksBeforeDeployingboolean | nullable

If set to true:

If all checks associated with the pipeline run successfully, the status of the pipeline will be switched to CHECKS_OK and the deployment will be executed.

If any of the checks associated with the pipeline fails, the status of the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline will be blocked.

If set to false (default):

If all checks associated with the pipeline run successfully, the status of the pipeline will be switched to CHECKS_OK and the deployment will be executed.

If any of the checks associated with the pipeline fails, the status of the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline

statusstring · enum | nullable

Options: NEW, FAILED, STARTING, STARTED, SCALING, CHECKS_OK, CHECKS_FAILED -

portKindstring · enum | nullable

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

Options: LoadBalancer, ClusterIP, NodePort

eventsobject[] | nullable

Pipeline Status event.

metadataobject | nullable

minReplicasinteger | nullable

maxReplicasinteger | nullable

scaleUpTypestring · enum | nullable

Options: Unknown, Pods, Percent

scaleUpValueinteger | nullable

scaleUpPeriodSecondsinteger | nullable

scaleDownTypestring · enum | nullable

Options: Unknown, Pods, Percent

scaleDownValueinteger | nullable

scaleDownPeriodSecondsinteger | nullable

utilizationCPUAverageinteger | nullable

utilizationMemoryAverageinteger | nullable

labelsobject | nullable

affinityobject | nullable

topologySpreadConstraintsobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "new-pipeline",
    "kind": "deployment",
    "deploymentStrategy": "rollingupdate",
    "replicasCount": null,
    "rawConfig": null,
    "configFormat": null,
    "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
    "secrets": null,
    "files": null,
    "resourceProfile": "my-resource-profile",
    "noAutoCreateEndpointsFromConfig": null,
    "noAutoCreateChecksFromConfig": null,
    "autoCreatePortsFromConfig": null,
    "autoCreateChecksFromConfig": null,
    "skipConfigValidation": false,
    "checksBeforeDeploying": null,
    "status": null,
    "portKind": null,
    "events": null,
    "metadata": null,
    "minReplicas": null,
    "maxReplicas": null,
    "scaleUpType": null,
    "scaleUpValue": null,
    "scaleUpPeriodSeconds": null,
    "scaleDownType": null,
    "scaleDownValue": null,
    "scaleDownPeriodSeconds": null,
    "utilizationCPUAverage": null,
    "utilizationMemoryAverage": null,
    "labels": null,
    "affinity": {
      "key": "text",
      "operator": "In",
      "values": [
        "text"
      ]
    },
    "topologySpreadConstraints": [
      {
        "maxSkew": 1,
        "topologyKey": "text",
        "whenUnsatisfiable": "DoNotSchedule",
        "labelSelector": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "minDomains": 1
      }
    ]
  }'

200

200

{
  "addedPorts": [
    {
      "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-03-12T04:25:20.116Z",
      "updatedAt": "2025-03-12T04:25:20.116Z"
    }
  ],
  "removedPorts": [
    {
      "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-03-12T04:25:20.116Z",
      "updatedAt": "2025-03-12T04:25:20.116Z"
    }
  ],
  "addedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 1,
      "host": "localhost",
      "createdAt": "2025-03-12T04:25:20.116Z",
      "updatedAt": "2025-03-12T04:25:20.116Z"
    }
  ],
  "removedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 1,
      "host": "localhost",
      "createdAt": "2025-03-12T04:25:20.116Z",
      "updatedAt": "2025-03-12T04:25:20.116Z"
    }
  ]
}

OK