Aggregator pipelines

Pipeline

get

Pipeline by ID.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Query parameters

config_formatstring · enumoptional

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-21T22:21:47.175Z"
  },
  "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-03-21T22:21:47.175Z",
      "updatedAt": "2025-03-21T22:21:47.175Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2025-03-21T22:21:47.175Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2025-03-21T22:21:47.175Z"
      }
    ],
    "createdAt": "2025-03-21T22:21:47.175Z"
  },
  "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-21T22:21:47.175Z",
    "updatedAt": "2025-03-21T22:21:47.175Z"
  },
  "deploymentStrategy": "rollingupdate",
  "tracingEnabled": true,
  "waitForChecksBeforeDeploying": true,
  "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-03-21T22:21:47.175Z",
      "updatedAt": "2025-03-21T22:21:47.175Z"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "Ynl0ZXM=",
      "encrypted": true,
      "createdAt": "2025-03-21T22:21:47.175Z",
      "updatedAt": "2025-03-21T22:21:47.175Z"
    }
  ],
  "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-03-21T22:21:47.175Z",
      "updatedAt": "2025-03-21T22:21:47.175Z"
    }
  ],
  "minReplicas": 1,
  "maxReplicas": 1,
  "scaleUpType": "Unknown",
  "scaleUpValue": 1,
  "scaleUpPeriodSeconds": 1,
  "scaleDownType": "Unknown",
  "scaleDownValue": 1,
  "scaleDownPeriodSeconds": 1,
  "utilizationCPUAverage": 1,
  "utilizationMemoryAverage": 1,
  "portKind": "LoadBalancer",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-03-21T22:21:47.175Z",
  "updatedAt": "2025-03-21T22:21:47.175Z"
}

OK

Delete pipeline

delete

Delete pipeline by its ID.

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

patch

Update pipeline by its ID.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Body

namestring | nullableoptional

DNS label format as of defined on RFC1123

Example: new-pipeline

kindstring · enum · default: "deployment"optional

Kind of deployment used when deploying this pipeline

Options: daemonSet, deployment

deploymentStrategystring · enum · default: "rollingupdate"optional

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

Options: rollingupdate, hotReload

replicasCountinteger | nullableoptional

rawConfigstring | nullableoptional

configFormatstring · enum | nullableoptional

Options: ini, json, yaml

imagestring | nullableoptional

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

secretsobject[] | nullableoptional

Update pipeline secret request body.

filesobject[] | nullableoptional

Update pipeline file request body.

resourceProfilestring | nullableoptional

Example: my-resource-profile

noAutoCreateEndpointsFromConfigboolean | nullableoptional

noAutoCreateChecksFromConfigboolean | nullableoptional

autoCreatePortsFromConfigboolean | nullableoptionalDeprecated

autoCreateChecksFromConfigboolean | nullableoptionalDeprecated

skipConfigValidationboolean · default: falseoptional

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

statusstring · enum | nullableoptional

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

portKindstring · enum | nullableoptional

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

Options: LoadBalancer, ClusterIP, NodePort

eventsobject[] | nullableoptional

Pipeline Status event.

metadataobject | nullableoptional

minReplicasinteger | nullableoptional

maxReplicasinteger | nullableoptional

scaleUpTypestring · enum | nullableoptional

Options: Unknown, Pods, Percent

scaleUpValueinteger | nullableoptional

scaleUpPeriodSecondsinteger | nullableoptional

scaleDownTypestring · enum | nullableoptional

Options: Unknown, Pods, Percent

scaleDownValueinteger | nullableoptional

scaleDownPeriodSecondsinteger | nullableoptional

utilizationCPUAverageinteger | nullableoptional

utilizationMemoryAverageinteger | nullableoptional

labelsobject | nullableoptional

affinityobject | nullableoptional

topologySpreadConstraintsobject[] | nullableoptional

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": "daemonSet",
    "deploymentStrategy": "rollingupdate",
    "replicasCount": 1,
    "rawConfig": "text",
    "configFormat": "ini",
    "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,
    "autoCreatePortsFromConfig": true,
    "autoCreateChecksFromConfig": true,
    "skipConfigValidation": true,
    "checksBeforeDeploying": true,
    "status": "NEW",
    "portKind": "LoadBalancer",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2025-03-21T22:21:47.175Z"
      }
    ],
    "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,
    "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
      }
    ]
  }'

application/json

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

OK