Aggregators

Create core instance

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.

post

/v1/aggregators

Authorizations

Body

namestring · hostnamerequired

Example: new-core-instance

imagestring | nullable

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

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

versionstringrequired

Example: v0.1.12

addHealthCheckPipelinebooleanrequired

clusterLoggingboolean

Enable cluster-logging functionality on this core instance.

healthCheckPipelinePortinteger · int32required

healthCheckPipelinePortKindstring · enum · default: LoadBalancerrequired

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

Options: LoadBalancer, ClusterIP, NodePort

metadataobject | nullable

environmentIDstring | nullable

environment ID to associate this core instance with.

skipServiceCreationboolean | nullable

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/aggregators' \
  --header 'X-Project-Token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": null,
    "environmentID": null,
    "skipServiceCreation": null
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "privateRSAKey": "text",
  "publicRSAKey": "text",
  "name": "my-core-instance",
  "version": "v0.1.12",
  "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
  "tags": null,
  "healthCheckPipeline": null,
  "clusterLoggingPipeline": null,
  "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-03-12T04:17:42.526Z",
      "updatedAt": "2025-03-12T04:17:42.526Z"
    }
  ],
  "environmentName": "default",
  "skipServiceCreation": false,
  "createdAt": "2025-03-12T04:17:42.526Z"
}

Created

Core instance

Core instance by ID.

get

/v1/aggregators/{aggregatorID}

Authorizations

userproject

Path parameters

aggregatorIDstring · uuidrequired

Query parameters

exclude_internalboolean

Exclude internal pipelines (health-check) from count.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "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-03-12T04:17:42.526Z",
  "updatedAt": "2025-03-12T04:17:42.526Z",
  "tags": null,
  "environmentName": "default",
  "skipServiceCreation": false
}

OK

Delete core instance

Delete core instance by its ID.

delete

/v1/aggregators/{aggregatorID}

Authorizations

userproject

Path parameters

aggregatorIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No Content

Update core instance

Update core instance by its ID.

patch

/v1/aggregators/{aggregatorID}

Authorizations

userproject

Path parameters

aggregatorIDstring · uuidrequired

Body

namestring · hostname | nullable

Example: new-core-instance

imagestring | nullable

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

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

clusterLoggingboolean | nullable

enable or disable cluster-logging functionality.

versionstring | nullable

Example: v0.1.12

tagsstring[] | nullable

metadataany of

Core Instance Metadata model.

Metadata model for AWS metadata fields accepted by a Core Instance. See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html

Metadata model for GCP metadata fields accepted by a Core Instance. See: https://cloud.google.com/compute/docs/metadata/default-metadata-values.

Metadata model for kubernetes metadata fields accepted by a Core Instance. See: https://github.com/kubernetes/website/blob/60390ff3c0ef0043a58568ad2e4c2b7634028074/content/en/examples/pods/inject/dapi-volume.yaml#L5

environmentIDstring | nullable

environment ID to associate this core instance with.

skipServiceCreationboolean | nullable

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

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "new-core-instance",
    "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
    "clusterLogging": null,
    "version": "v0.1.12",
    "tags": null,
    "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": null,
    "skipServiceCreation": null
  }'

204

204

No body

No Content