Aggregators

Core instances (deprecated)

Core instances from a project (deprecated).

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

Authorization

userproject

Path parameters

projectID*string (uuid)

Query parameters

Response

200

OK

Headers

Body

application/json

id*string (uuid)

token*string

Example: "redacted"

name*string (hostname)

Example: "my-core-instance"

versionstring

Example: "v0.1.12"

statusenum

Running status of the core 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

Example: "default"

skipServiceCreation*boolean

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "token": "redacted",
    "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"
    },
    "createdAt": "2024-10-16T11:22:02.159Z",
    "updatedAt": "2024-10-16T11:22:02.159Z",
    "tags": [
      "text"
    ],
    "environmentName": "default",
    "skipServiceCreation": false
  }
]

Delete Core instances

Delete core instances from a project.

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

Authorization

userproject

Path parameters

projectID*string (uuid)

Query parameters

Response

204

Deleted

Request

JavaScriptCurlPython

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