Aggregator pipelines

Pipeline

get

Pipeline by ID.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Query parameters

config_formatstring · enumOptional

Desired output config format.

Possible values:

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/aggregator_pipelines/{pipelineID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-pipeline",
  "kind": "deployment",
  "config": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "rawConfig": "text",
    "configFormat": "classic",
    "createdAt": "2025-06-06T01:57:47.399Z"
  },
  "configSections": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "kind": "input",
      "properties": [
        {
          "key": "name",
          "value": "dummy"
        }
      ],
      "createdAt": "2025-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2025-06-06T01:57:47.399Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2025-06-06T01:57:47.399Z"
      }
    ],
    "createdAt": "2025-06-06T01:57:47.399Z"
  },
  "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-06-06T01:57:47.399Z",
    "updatedAt": "2025-06-06T01:57:47.399Z"
  },
  "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": [
    "text"
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "mysecret",
      "value": "Ynl0ZXM=",
      "createdAt": "2025-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "Ynl0ZXM=",
      "encrypted": true,
      "createdAt": "2025-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "ports": [
    {
      "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-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "minReplicas": 1,
  "maxReplicas": 1,
  "scaleUpType": "Unknown",
  "scaleUpValue": 1,
  "scaleUpPeriodSeconds": 1,
  "scaleDownType": "Unknown",
  "scaleDownValue": 1,
  "scaleDownPeriodSeconds": 1,
  "utilizationCPUAverage": 1,
  "utilizationMemoryAverage": 1,
  "storageClass": "text",
  "pvcRetentionPolicy": {
    "whenScaled": "Retain",
    "whenDeleted": "Retain"
  },
  "portKind": "LoadBalancer",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-06-06T01:57:47.399Z",
  "updatedAt": "2025-06-06T01:57:47.399Z"
}

Delete pipeline

delete

Delete pipeline by its ID.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Responses

204

No Content

delete

HTTPcURLJavaScriptPython

DELETE /v1/aggregator_pipelines/{pipelineID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update pipeline

patch

Update pipeline by its ID.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Body

Update pipeline request body.

namestring | nullableOptional

DNS label format as of defined on RFC1123

Default: nullExample: new-pipeline

kindstring · enumOptional

Kind of deployment used when deploying this pipeline

Default: deploymentPossible values:

deploymentStrategystring · enumOptional

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

Default: rollingupdatePossible values:

replicasCountinteger | nullableOptionalDefault: null

rawConfigstring | nullableOptionalDefault: null

configFormatstring · enum | nullableOptionalDefault: nullPossible values:

imagestring | nullableOptionalDefault: nullExample: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2

resourceProfilestring | nullableOptionalDefault: nullExample: my-resource-profile

noAutoCreateEndpointsFromConfigboolean | nullableOptionalDefault: null

noAutoCreateChecksFromConfigboolean | nullableOptionalDefault: null

autoCreatePortsFromConfigboolean | nullableOptionalDeprecatedDefault: null

autoCreateChecksFromConfigboolean | nullableOptionalDeprecatedDefault: null

skipConfigValidationbooleanOptionalDefault: false

checksBeforeDeployingboolean | nullableOptional

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

Default: null

statusstring · enum | nullableOptionalDefault: nullPossible values:

portKindstring · enum | nullableOptional

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

Default: nullPossible values:

minReplicasinteger | nullableOptionalDefault: null

maxReplicasinteger | nullableOptionalDefault: null

scaleUpTypestring · enum | nullableOptionalDefault: nullPossible values:

scaleUpValueinteger | nullableOptionalDefault: null

scaleUpPeriodSecondsinteger | nullableOptionalDefault: null

scaleDownTypestring · enum | nullableOptionalDefault: nullPossible values:

scaleDownValueinteger | nullableOptionalDefault: null

scaleDownPeriodSecondsinteger | nullableOptionalDefault: null

utilizationCPUAverageinteger | nullableOptionalDefault: null

utilizationMemoryAverageinteger | nullableOptionalDefault: null

storageClassstring | nullableOptional

Represents the storageClass for PVC templates

Default: null

terminationGracePeriodSecondsinteger · int64 | nullableOptional

Responses

200

OK

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/aggregator_pipelines/{pipelineID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1752

{
  "name": "new-pipeline",
  "kind": "deployment",
  "deploymentStrategy": "rollingupdate",
  "replicasCount": 1,
  "rawConfig": "text",
  "configFormat": "classic",
  "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
  "secrets": [
    {
      "key": "newsecret",
      "value": "Ynl0ZXM="
    }
  ],
  "files": [
    {
      "name": "newfile",
      "contents": "Ynl0ZXM=",
      "encrypted": true
    }
  ],
  "resourceProfile": "my-resource-profile",
  "noAutoCreateEndpointsFromConfig": true,
  "noAutoCreateChecksFromConfig": true,
  "skipConfigValidation": false,
  "checksBeforeDeploying": true,
  "status": "NEW",
  "portKind": "LoadBalancer",
  "events": [
    {
      "source": "k8s:deployment",
      "reason": "text",
      "message": "text",
      "loggedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "minReplicas": 1,
  "maxReplicas": 1,
  "scaleUpType": "Unknown",
  "scaleUpValue": 1,
  "scaleUpPeriodSeconds": 1,
  "scaleDownType": "Unknown",
  "scaleDownValue": 1,
  "scaleDownPeriodSeconds": 1,
  "utilizationCPUAverage": 1,
  "utilizationMemoryAverage": 1,
  "storageClass": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "affinity": {
    "key": "text",
    "operator": "In",
    "values": [
      "text"
    ]
  },
  "topologySpreadConstraints": [
    {
      "maxSkew": 1,
      "topologyKey": "text",
      "whenUnsatisfiable": "DoNotSchedule",
      "labelSelector": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "minDomains": 1
    }
  ],
  "terminationGracePeriodSeconds": 1,
  "lifecycle": {
    "preStop": {
      "exec": {
        "command": [
          "text"
        ]
      },
      "httpGet": {
        "path": "text",
        "port": 1,
        "host": "text",
        "scheme": "HTTP",
        "httpHeaders": [
          {
            "name": "text",
            "value": "text"
          }
        ]
      },
      "tcpSocket": {
        "port": 1,
        "host": "text"
      },
      "sleep": {
        "seconds": 1
      }
    },
    "postStart": {
      "exec": {
        "command": [
          "text"
        ]
      },
      "httpGet": {
        "path": "text",
        "port": 1,
        "host": "text",
        "scheme": "HTTP",
        "httpHeaders": [
          {
            "name": "text",
            "value": "text"
          }
        ]
      },
      "tcpSocket": {
        "port": 1,
        "host": "text"
      },
      "sleep": {
        "seconds": 1
      }
    }
  },
  "pvcRetentionPolicy": {
    "whenScaled": "Retain",
    "whenDeleted": "Retain"
  }
}

200

OK

{
  "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-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "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-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "addedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 1,
      "host": "localhost",
      "createdAt": "2025-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ],
  "removedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 1,
      "host": "localhost",
      "createdAt": "2025-06-06T01:57:47.399Z",
      "updatedAt": "2025-06-06T01:57:47.399Z"
    }
  ]
}