Pipelines

PreviousResource profiles NextPipelines metrics

Delete Pipelines

delete

Delete pipelines from a core instance.

Authorizations

Path parameters

aggregatorIDstring · uuidRequired

Query parameters

pipeline_idstring · uuid[]Optional

List of pipeline IDs to delete.

Responses

delete

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

204

Deleted

No content

Deprecated

Pipelines (deprecated)

get

Pipelines from a core instance (deprecated).

Authorizations

Path parameters

aggregatorIDstring · uuidRequired

Query parameters

lastintegerOptional

Last pipelines.

beforestringOptional

Pipelines before the given cursor.

namestringOptional

Name matching pipelines.

tags_querystringOptional

Tag query.

Example: tagone AND tagtwo

config_formatstring · enumOptional

Desired output config format.

Available options:

includestring · enumOptional

Include all ports, secrets and files objects in the pipeline.

Available options:

exclude_internalbooleanOptional

Exclude internal pipelines (health-check).

Responses

application/json

object[]Optional

Pipeline model.

get

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

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-04-24T07:37:30.180Z"
    },
    "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-04-24T07:37:30.180Z",
        "updatedAt": "2025-04-24T07:37:30.180Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2025-04-24T07:37:30.180Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2025-04-24T07:37:30.180Z"
        }
      ],
      "createdAt": "2025-04-24T07:37:30.180Z"
    },
    "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-04-24T07:37:30.180Z",
      "updatedAt": "2025-04-24T07:37:30.180Z"
    },
    "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-04-24T07:37:30.180Z",
        "updatedAt": "2025-04-24T07:37:30.180Z"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
        "name": "myfile",
        "contents": "Ynl0ZXM=",
        "encrypted": true,
        "createdAt": "2025-04-24T07:37:30.180Z",
        "updatedAt": "2025-04-24T07:37:30.180Z"
      }
    ],
    "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-04-24T07:37:30.180Z",
        "updatedAt": "2025-04-24T07:37:30.180Z"
      }
    ],
    "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-04-24T07:37:30.180Z",
    "updatedAt": "2025-04-24T07:37:30.180Z"
  }
]

Create pipeline

post

Create pipeline within a core instance. The pipeline name must be unique within the core instance. The resource profile must exist already. If you don't provide one, it will default to "best-effort-low-resource". Use them to easily deploy configured agents to the core instance.

Authorizations

Path parameters

aggregatorIDstring · uuidRequired

Body

Create pipeline request body.

namestringRequired

DNS label format as of defined on RFC1123

Example: new-pipeline

kindstring · enumOptionalDefault: deploymentAvailable options:

replicasCountintegerRequired

rawConfigstringRequired

configFormatstring · enumOptionalDefault: classicExample: yamlAvailable options:

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

secretsobject[] | nullableRequired

Create pipeline secret request body.

Default: null

filesobject[] | nullableRequired

Create pipeline file request body.

Default: null

resourceProfilestringRequiredExample: my-resource-profile

noAutoCreateChecksFromConfigbooleanOptional

If true, no Pipeline checks will be auto-generated from the configuration.

Default: false

autoCreateChecksFromConfigbooleanOptionalDeprecated

If true, this will automatically create a set of Pipeline checks to validate that the configured output services are reachable.

Default: false

waitForChecksBeforeDeployingbooleanOptional

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 will be executed.

Default: false

noAutoCreateEndpointsFromConfigbooleanOptional

if true, no ports will be automatically generated from the configuration.

Default: false

autoCreatePortsFromConfigbooleanOptionalDeprecatedDefault: false

skipConfigValidationbooleanRequired

metadataobject | nullableOptionalDefault: null

portKindstring · enumRequired

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

Default: LoadBalancerAvailable options:

minReplicasintegerRequiredDefault: 0

maxReplicasintegerRequiredDefault: 0

scaleUpTypestring · enumRequiredDefault: UnknownAvailable options:

scaleUpValueintegerRequiredDefault: 0

scaleUpPeriodSecondsintegerRequiredDefault: 0

scaleDownTypestring · enumRequiredDefault: UnknownAvailable options:

scaleDownValueintegerRequiredDefault: 0

scaleDownPeriodSecondsintegerRequiredDefault: 0

utilizationCPUAverageintegerRequiredDefault: 0

utilizationMemoryAverageintegerRequiredDefault: 0

labelsobject | nullableOptionalDefault: null

affinityobject | nullableOptional

topologySpreadConstraintsobject[] | nullableOptional

tolerationsobject[] | nullableOptional

terminationGracePeriodSecondsinteger · int64 | nullableOptional

lifecycleobject | nullableOptional

Responses

application/json

objectOptional

Created pipeline response body.

post

POST /v1/aggregators/{aggregatorID}/pipelines HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1612

{
  "name": "new-pipeline",
  "kind": "deployment",
  "replicasCount": 1,
  "rawConfig": "text",
  "configFormat": "yaml",
  "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",
  "noAutoCreateChecksFromConfig": true,
  "waitForChecksBeforeDeploying": true,
  "noAutoCreateEndpointsFromConfig": true,
  "skipConfigValidation": true,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "portKind": "LoadBalancer",
  "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
    }
  ],
  "tolerations": [
    {
      "key": "text",
      "operator": "Equal",
      "value": "text",
      "effect": "NoSchedule",
      "tolerationSeconds": 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
      }
    }
  }
}

201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-pipeline",
  "kind": "deployment",
  "config": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "rawConfig": "text",
    "configFormat": "ini",
    "createdAt": "2025-04-24T07:37:30.180Z"
  },
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2025-04-24T07:37:30.180Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2025-04-24T07:37:30.180Z"
      }
    ],
    "createdAt": "2025-04-24T07:37:30.180Z"
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "mysecret",
      "value": "Ynl0ZXM=",
      "createdAt": "2025-04-24T07:37:30.180Z",
      "updatedAt": "2025-04-24T07:37:30.180Z"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "Ynl0ZXM=",
      "encrypted": true,
      "createdAt": "2025-04-24T07:37:30.180Z",
      "updatedAt": "2025-04-24T07:37:30.180Z"
    }
  ],
  "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-04-24T07:37:30.180Z",
    "updatedAt": "2025-04-24T07:37:30.180Z"
  },
  "checks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 1,
      "port": 1,
      "host": "localhost",
      "createdAt": "2025-04-24T07:37:30.180Z",
      "updatedAt": "2025-04-24T07:37:30.180Z"
    }
  ],
  "createdAt": "2025-04-24T07:37:30.180Z"
}