Support PortalCalyptia CoreContact Us

Aggregators

Create core instance

post

Create core instance within a project. The project in which the core instance is created is parser from the authorization token. Users are not allowed to create core instances.

Authorizations
Body

Create core instance request body.

namestring · hostnameRequiredExample: new-core-instance
imagestring | nullableOptional

default core-fluent-bit image to use by the pipelines created on this core_instance.

Default: nullExample: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2
versionstringRequiredExample: v0.1.12
addHealthCheckPipelinebooleanRequired
clusterLoggingbooleanOptional

Enable cluster-logging functionality on this core instance.

healthCheckPipelinePortinteger · int32Required
healthCheckPipelinePortKindstring · enumRequired

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

Default: LoadBalancerPossible values:
metadataobject | nullableOptionalDefault: null
environmentIDstring | nullableOptional

environment ID to associate this core instance with.

Default: null
skipServiceCreationboolean | nullableOptional

If true, kubernetes service creation will be skipped for all pipelines that exists on this core_instance.

Default: null
Responses
201
Created
application/json
post
POST /v1/aggregators HTTP/1.1
Host: cloud-api.calyptia.com
X-Project-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "name": "new-core-instance",
  "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
  "version": "v0.1.12",
  "addHealthCheckPipeline": true,
  "clusterLogging": true,
  "healthCheckPipelinePort": 1,
  "healthCheckPipelinePortKind": "LoadBalancer",
  "metadata": {},
  "environmentID": "text",
  "skipServiceCreation": true
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "privateRSAKey": "Ynl0ZXM=",
  "publicRSAKey": "Ynl0ZXM=",
  "name": "my-core-instance",
  "version": "v0.1.12",
  "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
  "tags": [
    "text"
  ],
  "healthCheckPipeline": {
    "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-27T23:07:08.118Z"
    },
    "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-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2025-06-27T23:07:08.118Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2025-06-27T23:07:08.118Z"
        }
      ],
      "createdAt": "2025-06-27T23:07:08.118Z"
    },
    "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-27T23:07:08.118Z",
      "updatedAt": "2025-06-27T23:07:08.118Z"
    },
    "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-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
        "name": "myfile",
        "contents": "Ynl0ZXM=",
        "encrypted": true,
        "createdAt": "2025-06-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "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-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "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-27T23:07:08.118Z",
    "updatedAt": "2025-06-27T23:07:08.118Z"
  },
  "clusterLoggingPipeline": {
    "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-27T23:07:08.118Z"
    },
    "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-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2025-06-27T23:07:08.118Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2025-06-27T23:07:08.118Z"
        }
      ],
      "createdAt": "2025-06-27T23:07:08.118Z"
    },
    "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-27T23:07:08.118Z",
      "updatedAt": "2025-06-27T23:07:08.118Z"
    },
    "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-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
        "name": "myfile",
        "contents": "Ynl0ZXM=",
        "encrypted": true,
        "createdAt": "2025-06-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "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-27T23:07:08.118Z",
        "updatedAt": "2025-06-27T23:07:08.118Z"
      }
    ],
    "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-27T23:07:08.118Z",
    "updatedAt": "2025-06-27T23:07:08.118Z"
  },
  "resourceProfiles": [
    {
      "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-27T23:07:08.118Z",
      "updatedAt": "2025-06-27T23:07:08.118Z"
    }
  ],
  "environmentName": "default",
  "skipServiceCreation": false,
  "createdAt": "2025-06-27T23:07:08.118Z"
}

Core instance

get

Core instance by ID.

Authorizations
Path parameters
aggregatorIDstring · uuidRequired
Query parameters
exclude_internalbooleanOptional

Exclude internal pipelines (health-check) from count.

Responses
200
OK
application/json
get
GET /v1/aggregators/{aggregatorID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-core-instance",
  "version": "v0.1.12",
  "status": "running",
  "metadata": {
    "aws.ami_id": "text",
    "aws.account_id": "text",
    "aws.hostname": "text",
    "aws.vpc_id": "text",
    "aws.private_ipv4": "text",
    "aws.public_ipv4": "text",
    "aws.ec2_instance_id": "text",
    "aws.ec2_instance_type": "text",
    "aws.az": "text"
  },
  "pipelinesCount": 1,
  "createdAt": "2025-06-27T23:07:08.118Z",
  "updatedAt": "2025-06-27T23:07:08.118Z",
  "tags": [
    "text"
  ],
  "environmentName": "default",
  "skipServiceCreation": false
}

Delete core instance

delete

Delete core instance by its ID.

Authorizations
Path parameters
aggregatorIDstring · uuidRequired
Responses
204
No Content
delete
DELETE /v1/aggregators/{aggregatorID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

Update core instance

patch

Update core instance by its ID.

Authorizations
Path parameters
aggregatorIDstring · uuidRequired
Body

Update core instance request body.

namestring · hostname | nullableOptionalDefault: nullExample: new-core-instance
imagestring | nullableOptional

default core-fluent-bit image to use by the pipelines created on this core_instance.

Default: nullExample: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2
clusterLoggingboolean | nullableOptional

enable or disable cluster-logging functionality.

Default: null
versionstring | nullableOptionalDefault: nullExample: v0.1.12
tagsstring[] | nullableOptionalDefault: null
metadataany ofOptional

Core Instance Metadata model.

or
or
environmentIDstring | nullableOptional

environment ID to associate this core instance with.

Default: null
skipServiceCreationboolean | nullableOptional

If true, kubernetes service creation will be skipped for all pipelines that exists on this core_instance.

Default: null
Responses
204
No Content
patch
PATCH /v1/aggregators/{aggregatorID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 421

{
  "name": "new-core-instance",
  "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
  "clusterLogging": true,
  "version": "v0.1.12",
  "tags": [
    "text"
  ],
  "metadata": {
    "aws.ami_id": "text",
    "aws.account_id": "text",
    "aws.hostname": "text",
    "aws.vpc_id": "text",
    "aws.private_ipv4": "text",
    "aws.public_ipv4": "text",
    "aws.ec2_instance_id": "text",
    "aws.ec2_instance_type": "text",
    "aws.az": "text"
  },
  "environmentID": "text",
  "skipServiceCreation": true
}
204

No Content

No content
PreviousErrorsNextPing