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

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

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

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

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

5 operations 2 paths 34 schemas 1 DELETE2 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 sidecar 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 5

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

sidecar 5
POST
/v1/pipelines/{pipelineID}/sidecars
Create sidecar
createSidecar 1 param body → 201
GET
/v1/pipelines/{pipelineID}/sidecars
Sidecars
sidecars 1 param → 200
GET
/v1/sidecars/{sidecarID}
Sidecar
sidecar 1 param → 200
PATCH
/v1/sidecars/{sidecarID}
Update sidecar
updateSidecar 1 param body → 200
DELETE
/v1/sidecars/{sidecarID}
Delete sidecar
deleteSidecar 1 param → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Sidecar (17 properties), CreateSidecar (14 properties), UpdateSidecar (14 properties), Probe (10 properties). Each schema is shown below with its type and property counts.

CreateSidecar
object
14 properties 2 required
EnvVarSource
object
2 properties
ContainerPort
object
3 properties 1 required
SecretKeySelector
object
2 properties 2 required
PullPolicy
string
Sidecars
object
2 properties 2 required
URIScheme
string
ConfigMapVolumeSource
object
4 properties 1 required
SecretVolumeSource
object
4 properties 1 required
Probe
object
10 properties
Protocol
string
KeyToPath
object
3 properties 2 required
Created
object
2 properties 2 required
LifecycleHandler
object
4 properties
ConfigMapKeySelector
object
2 properties 2 required
TCPSocketAction
object
2 properties 1 required
Sidecar
object
17 properties 6 required
VolumeMount
object
6 properties 2 required
ResourceRequirements
object
2 properties
ResourceList
object
2 properties
Lifecycle
object
2 properties
EmptyDirVolumeSource
object
2 properties
Volume
object
4 properties 1 required
MountPropagationMode
string
HTTPHeader
object
2 properties 2 required
EnvVar
object
3 properties 1 required
SleepAction
object
1 property 1 required
GRPCAction
object
2 properties 1 required
HTTPGetAction
object
5 properties 1 required
StorageMedium
string
Deleted
object
2 properties 2 required
ExecAction
object
1 property 1 required
Updated
object
1 property 1 required
UpdateSidecar
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-sidecar-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 API
Calyptia cluster_object_regex API
Calyptia config_section API
Calyptia config_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API