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 cluster_object API

The cluster_object API from Calyptia — 2 operation(s) for cluster_object.

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

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

This API exposes 4 operations across 2 paths, and defines 6 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}.

4 operations 2 paths 6 schemas 1 DELETE1 GET1 PATCH1 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 cluster_object 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 4

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

cluster_object 4
POST
/v1/core_instances/{coreInstanceID}/cluster_objects
Create cluster object
createClusterObject 1 param body → 201
GET
/v1/core_instances/{coreInstanceID}/cluster_objects
Cluster objects
clusterObjects 5 params → 200
PATCH
/v1/cluster_objects/{clusterObjectID}
Update cluster object
updateClusterObject 1 param body → 200
DELETE
/v1/cluster_objects/{clusterObjectID}
Delete cluster object
deleteClusterObject 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ClusterObject (5 properties), UpdateClusterObject (2 properties), CreatedClusterObject (2 properties), CreateClusterObject (2 properties). Each schema is shown below with its type and property counts.

UpdatedClusterObject
object
1 property 1 required
CreateClusterObject
object
Request body to create a new cluster object for a core instance.
2 properties 2 required
ClusterObject
object
A kubernetes cluster object that belongs to a given core instance.
5 properties 5 required
CreatedClusterObject
object
Response body for for a newly created cluster object.
2 properties 2 required
ClusterObjectKind
string
Kind of the kubernetes object
UpdateClusterObject
object
Request body to update a cluster object.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-cluster-object-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

Calyptia agent API
Calyptia agent_config API
Calyptia agent_error API
Calyptia aggregator API
Calyptia audit_log API
Calyptia aws_marketplace 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