Calyptia Core API
Support PortalCalyptia CoreContact Us

Aggregator pipelines

Project pipelines (deprecated)

Pipelines from a project (deprecated).

GEThttps://cloud-api.calyptia.com/v1/projects/{projectID}/aggregator_pipelines
Authorization
Path parameters
projectID*string (uuid)
Query parameters
Response

OK

Body
id*string (uuid)
name*string

DNS label format as of defined on RFC1123

Example: "my-pipeline"
kind*PipelineKind (enum)
deploymentdaemonSet
config*PipelineConfig (object)

Pipeline configuration history entry.

configSections*array of ConfigSection (object)
status*PipelineStatus (object)

Pipeline status history entry.

resourceProfile*ResourceProfile (object)

Resource profile model.

deploymentStrategy*DeploymentStrategy (enum)

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

recreatehotReload
tracingEnabled*boolean
waitForChecksBeforeDeploying*boolean
image*nullable string
Example: "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2"
replicasCount*integer
replicasCountPrev*integer

the previous replica set counter

checksTotal*integer

total number of checks associated with the pipeline.

checksOK*integer

total number of checks with ok status.

checksRunning*integer

total number of checks with running status.

tags*nullable array of string
metadata*nullable object
secretsnullable array of PipelineSecret (object)
filesnullable array of PipelineFile (object)
portsnullable array of PipelinePort (object)
minReplicas*integer

minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.

maxReplicas*integer

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.

scaleUpType*ScalePolicy (enum)
UnknownPodsPercent
scaleUpValue*integer

value contains the amount of change which is permitted by the policy.

scaleUpPeriodSeconds*integer

ScaleUpPeriodSeconds specifies the window of time for which the policy should hold true.

scaleDownType*ScalePolicy (enum)
UnknownPodsPercent
scaleDownValue*integer

value contains the amount of change which is permitted by the policy.

scaleDownPeriodSeconds*integer

ScaleUpPeriodSeconds specifies the window of time for which the policy should hold true.

utilizationCPUAverage*integer

UtilizationCPUAverage defines the target value for average CPU utilization

utilizationMemoryAverage*integer

UtilizationMemoryAverage defines the target value for average CPU utilization

portKind*PipelinePortKind (enum)

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

LoadBalancerClusterIPNodePort
createdAt*string (date-time)
updatedAt*string (date-time)
Request
const response = await fetch('https://cloud-api.calyptia.com/v1/projects/{projectID}/aggregator_pipelines', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();
Response
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-pipeline",
    "kind": "deployment",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "configFormat": "ini",
      "createdAt": "2024-11-21T10:03:58.420Z"
    },
    "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": "2024-11-21T10:03:58.420Z",
        "updatedAt": "2024-11-21T10:03:58.420Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2024-11-21T10:03:58.420Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2024-11-21T10:03:58.420Z"
        }
      ],
      "createdAt": "2024-11-21T10:03:58.420Z"
    },
    "resourceProfile": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "my-resource-profile",
      "storageSyncFull": false,
      "storageBacklogMemLimit": "1Mi",
      "storageVolumeSize": "2Mi",
      "storageMaxChunksPause": false,
      "cpuLimit": "3Mi",
      "cpuRequest": "4Mi",
      "memoryLimit": "5Mi",
      "memoryRequest": "6Mi",
      "createdAt": "2024-11-21T10:03:58.420Z",
      "updatedAt": "2024-11-21T10:03:58.420Z"
    },
    "deploymentStrategy": "recreate",
    "tracingEnabled": false,
    "waitForChecksBeforeDeploying": false,
    "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
    "tags": [
      "text"
    ],
    "secrets": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "key": "mysecret",
        "value": "Ynl0ZXM=",
        "createdAt": "2024-11-21T10:03:58.420Z",
        "updatedAt": "2024-11-21T10:03:58.420Z"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
        "name": "myfile",
        "contents": "Ynl0ZXM=",
        "encrypted": false,
        "createdAt": "2024-11-21T10:03:58.420Z",
        "updatedAt": "2024-11-21T10:03:58.420Z"
      }
    ],
    "ports": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "protocol": "tcp",
        "kind": "LoadBalancer",
        "endpoint": "text",
        "pluginID": "forward.0",
        "pluginName": "forward",
        "pluginAlias": "myforwardinput",
        "createdAt": "2024-11-21T10:03:58.420Z",
        "updatedAt": "2024-11-21T10:03:58.420Z"
      }
    ],
    "scaleUpType": "Unknown",
    "scaleDownType": "Unknown",
    "portKind": "LoadBalancer",
    "createdAt": "2024-11-21T10:03:58.420Z",
    "updatedAt": "2024-11-21T10:03:58.420Z"
  }
]
PreviousCore instancesNextPipelines