Aggregators

Create aggregator

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

POSThttps://cloud-api.calyptia.com/v1/aggregators

Authorization

project

Body

application/json

name*string (hostname)

version*string

addHealthCheckPipeline*boolean

clusterLoggingboolean

Enable cluster-logging functionality on this aggregator instance.

healthCheckPipelinePort*integer (int32)

metadatanullable object

environmentIDnullable string

environment ID to associate this aggregator with.

Response

201

Created

Body

application/json

id*string (uuid)

token*string

privateRSAKey*string (byte)

publicRSAKey*string (byte)

name*string (hostname)

versionstring

createdAt*string (date-time)

healthCheckPipelinePipeline (object)

Pipeline model.

clusterLoggingPipelinePipeline (object)

Pipeline model.

resourceProfiles*array of ResourceProfile (object)

environmentNamestring

environment name on which the agent belongs to.

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "new-aggregator",
      "version": "v0.1.12",
      "addHealthCheckPipeline": false
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "redacted",
  "privateRSAKey": "Ynl0ZXM=",
  "publicRSAKey": "Ynl0ZXM=",
  "name": "my-aggregator",
  "version": "v0.1.12",
  "createdAt": "2024-04-19T21:51:09.579Z",
  "healthCheckPipeline": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-pipeline",
    "kind": "daemonSet",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "configFormat": "ini",
      "createdAt": "2024-04-19T21:51:09.579Z"
    },
    "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-04-19T21:51:09.579Z",
        "updatedAt": "2024-04-19T21:51:09.579Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2024-04-19T21:51:09.579Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2024-04-19T21:51:09.579Z"
        }
      ],
      "createdAt": "2024-04-19T21:51:09.579Z"
    },
    "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-04-19T21:51:09.579Z",
      "updatedAt": "2024-04-19T21:51:09.579Z"
    },
    "tags": [
      "text"
    ],
    "metadata": {},
    "createdAt": "2024-04-19T21:51:09.579Z",
    "updatedAt": "2024-04-19T21:51:09.579Z"
  },
  "clusterLoggingPipeline": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-pipeline",
    "kind": "daemonSet",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "configFormat": "ini",
      "createdAt": "2024-04-19T21:51:09.579Z"
    },
    "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-04-19T21:51:09.579Z",
        "updatedAt": "2024-04-19T21:51:09.579Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2024-04-19T21:51:09.579Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2024-04-19T21:51:09.579Z"
        }
      ],
      "createdAt": "2024-04-19T21:51:09.579Z"
    },
    "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-04-19T21:51:09.579Z",
      "updatedAt": "2024-04-19T21:51:09.579Z"
    },
    "tags": [
      "text"
    ],
    "metadata": {},
    "createdAt": "2024-04-19T21:51:09.579Z",
    "updatedAt": "2024-04-19T21:51:09.579Z"
  },
  "resourceProfiles": [
    {
      "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-04-19T21:51:09.579Z",
      "updatedAt": "2024-04-19T21:51:09.579Z"
    }
  ],
  "environmentName": "default"
}

Aggregator

Aggregator by ID.

GEThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}

Authorization

userproject

Path parameters

aggregatorID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

token*string

name*string (hostname)

versionstring

statusenum

Running status of the aggregator instance in reference to the last ping. Refer to https://pkg.go.dev/github.com/calyptia/api@main/types#pkg-constants if looking up for the current timeout defaults.

runningwaitingunreachable

metadataCoreInstanceMetadata (object)

Core Instance Metadata model.

MetadataAWS (object)MetadataGCP (object)MetadataK8S (object)

pipelinesCount*integer

createdAt*string (date-time)

updatedAt*string (date-time)

tagsnullable array of string

environmentName*string

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "redacted",
  "name": "my-aggregator",
  "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"
  },
  "createdAt": "2024-04-19T21:51:09.579Z",
  "updatedAt": "2024-04-19T21:51:09.579Z",
  "tags": [
    "text"
  ],
  "environmentName": "default"
}

Delete aggregator

Delete aggregator by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}

Authorization

userproject

Path parameters

aggregatorID*string (uuid)

Response

204

No Content

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update aggregator

Update aggregator by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}

Authorization

userproject

Path parameters

aggregatorID*string (uuid)

Body

application/json

namenullable string (hostname)

clusterLoggingnullable boolean

enable or disable cluster-logging functionality.

versionnullable string

tagsnullable array of string

metadataCoreInstanceMetadata (object)

Core Instance Metadata model.

MetadataAWS (object)MetadataGCP (object)MetadataK8S (object)

environmentIDnullable string

environment ID to associate this aggregator with.

Response

204

No Content

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();