Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Calyptia aggregator API

The aggregator API from Calyptia — 4 operation(s) for aggregator.

Calyptia aggregator API is one of 41 APIs that Calyptia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include aggregator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths, and defines 27 schemas. It is described by OpenAPI 3.0.4, at version 1.0.

Requests are made against 4 base URLs: https://cloud-api.calyptia.com, https://cloud-api-dev.calyptia.com, https://cloud-api-staging.calyptia.com, http://localhost:{port}.

7 operations 4 paths 27 schemas 2 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.0
Base URL
https://cloud-api.calyptia.com
Authentication
HTTP Bearer, API Key, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Calyptia aggregator API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (user). An API key is passed in the header as X-Project-Token (project). It supports OAuth 2.0 (auth0) using the clientCredentials and authorizationCode flows.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

aggregator 7
POST
/v1/aggregators
Create core instance
createAggregator body → 201
GET
/v1/projects/{projectID}/aggregatorsdeprecated
Core instances (deprecated)
aggregators 7 params → 200
DELETE
/v1/projects/{projectID}/aggregators
Delete Core instances
deleteAggregators 2 params → 204
POST
/v1/aggregators/{aggregatorID}/ping
Ping Cloud API by core instance ID
aggregatorPing 1 param → 200
GET
/v1/aggregators/{aggregatorID}
Core instance
aggregator 2 params → 200
PATCH
/v1/aggregators/{aggregatorID}
Update core instance
updateAggregator 1 param body → 204
DELETE
/v1/aggregators/{aggregatorID}
Delete core instance
deleteAggregator 1 param → 204

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Pipeline (38 properties), ResourceProfile (14 properties), CreatedAggregator (13 properties), Aggregator (11 properties). Each schema is shown below with its type and property counts.

ConfigSectionKind
string
AggregatorPingResponse
object
Core instance ping response model.
1 property
DeploymentStrategy
string
The deployment strategy to use when creating or updating changes to this pipeline.
PipelineFile
object
Pipeline file model.
7 properties 7 required
PipelinePortKind
string
The kind/type of the service associated to this port.
PVCRetentionPolicy
object
Defines what happens to PVCs when StatefulSets are scaled or deleted (K8s 1.23+)
2 properties
PipelinePort
object
Pipeline port model.
11 properties 11 required
PipelineStatus
object
Pipeline status history entry.
5 properties 4 required
MetadataAWS
object
Metadata model for AWS metadata fields accepted by a Core Instance. See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html
9 properties
CreateAggregator
object
Create core instance request body.
10 properties 5 required
PipelineConfig
object
Pipeline configuration history entry.
4 properties 4 required
AgentConfig
object
Agent configuration history entry.
3 properties 3 required
ScalePolicy
string
CreatedAggregator
object
Created core instance response body.
13 properties 13 required
CoreInstanceMetadata
object
Core Instance Metadata model.
MetadataK8S
object
Metadata model for kubernetes metadata fields accepted by a Core Instance. See: https://github.com/kubernetes/website/blob/60390ff3c0ef0043a58568ad2e4c2b763402…
5 properties
UpdateAggregator
object
Update core instance request body.
8 properties
ConfigSection
object
7 properties 7 required
PipelineKind
string
Pipeline
object
Pipeline model.
38 properties 32 required
ResourceProfile
object
Resource profile model.
14 properties 14 required
PipelineEvent
object
Pipeline Status event.
4 properties 3 required
PipelineSecret
object
Pipeline secret model.
5 properties 5 required
Aggregator
object
Core instance model.
11 properties 7 required
Pair
object
2 properties 2 required
Pairs
array
MetadataGCP
object
Metadata model for GCP metadata fields accepted by a Core Instance. See: https://cloud.google.com/compute/docs/metadata/default-metadata-values.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-aggregator-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

Calyptia agent API
Calyptia agent_config API
Calyptia agent_error API
Calyptia audit_log API
Calyptia aws_marketplace API
Calyptia cluster_object API
Calyptia cluster_object_regex API
Calyptia config_section API
Calyptia config_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API
Calyptia core_instance_check API