Calyptia sidecar API
The sidecar API from Calyptia — 2 operation(s) for sidecar.
The sidecar API from Calyptia — 2 operation(s) for sidecar.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/calyptia-sidecar-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Calyptia Cloud agent Sidecar API
version: '1.0'
description: HTTP API service of Calyptia Cloud
contact:
name: Calyptia
email: hello@calyptia.com
url: https://cloud.calyptia.com
termsOfService: https://calyptia.com/terms/
servers:
- url: https://cloud-api.calyptia.com
description: prod
- url: https://cloud-api-dev.calyptia.com
description: dev
- url: https://cloud-api-staging.calyptia.com
description: staging
- url: http://localhost:{port}
description: local
variables:
port:
default: '5000'
tags:
- name: sidecar
paths:
/v1/pipelines/{pipelineID}/sidecars:
parameters:
- schema:
type: string
format: uuid
name: pipelineID
in: path
required: true
post:
tags:
- sidecar
summary: Create sidecar
operationId: createSidecar
description: Create a new sidecar container within a pipeline.
security:
- user: []
- project: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSidecar'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Created'
get:
tags:
- sidecar
summary: Sidecars
operationId: sidecars
description: List all sidecar containers from a pipeline.
security:
- user: []
- project: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Sidecars'
/v1/sidecars/{sidecarID}:
parameters:
- schema:
type: string
format: uuid
name: sidecarID
in: path
required: true
get:
tags:
- sidecar
summary: Sidecar
operationId: sidecar
description: Get sidecar by ID.
security:
- user: []
- project: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Sidecar'
patch:
tags:
- sidecar
summary: Update sidecar
operationId: updateSidecar
description: Update sidecar by ID.
security:
- user: []
- project: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSidecar'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Updated'
delete:
tags:
- sidecar
summary: Delete sidecar
operationId: deleteSidecar
description: Delete sidecar by ID.
security:
- user: []
- project: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Deleted'
components:
schemas:
UpdateSidecar:
type: object
properties:
name:
type: string
example: my-sidecar
image:
type:
- string
- 'null'
example: nginx:latest
imagePullPolicy:
$ref: '#/components/schemas/PullPolicy'
command:
type:
- array
- 'null'
items:
type: string
example:
- /bin/sh
- -c
- nginx
args:
type:
- array
- 'null'
items:
type: string
example:
- -c
- nginx
env:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnvVar'
resources:
$ref: '#/components/schemas/ResourceRequirements'
ports:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ContainerPort'
volumeMounts:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VolumeMount'
volumes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Volume'
livenessProbe:
$ref: '#/components/schemas/Probe'
readinessProbe:
$ref: '#/components/schemas/Probe'
startupProbe:
$ref: '#/components/schemas/Probe'
lifecycle:
$ref: '#/components/schemas/Lifecycle'
Sidecar:
type: object
properties:
id:
type: string
format: uuid
pipelineID:
type: string
format: uuid
name:
type: string
example: my-sidecar
image:
type: string
example: nginx:latest
imagePullPolicy:
$ref: '#/components/schemas/PullPolicy'
command:
type:
- array
- 'null'
items:
type: string
example:
- /bin/sh
- -c
- nginx
args:
type:
- array
- 'null'
items:
type: string
example:
- -c
- nginx
env:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnvVar'
resources:
$ref: '#/components/schemas/ResourceRequirements'
ports:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ContainerPort'
volumeMounts:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VolumeMount'
volumes:
type: array
items:
$ref: '#/components/schemas/Volume'
livenessProbe:
$ref: '#/components/schemas/Probe'
readinessProbe:
$ref: '#/components/schemas/Probe'
startupProbe:
$ref: '#/components/schemas/Probe'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- pipelineID
- image
- name
- createdAt
- updatedAt
EnvVarSource:
type: object
properties:
secretKeyRef:
$ref: '#/components/schemas/SecretKeySelector'
configMapKeyRef:
$ref: '#/components/schemas/ConfigMapKeySelector'
EnvVar:
type: object
properties:
name:
type: string
value:
type: string
valueFrom:
$ref: '#/components/schemas/EnvVarSource'
required:
- name
Updated:
type: object
properties:
updatedAt:
type: string
format: date-time
required:
- updatedAt
ConfigMapVolumeSource:
type: object
properties:
name:
type: string
defaultMode:
type:
- integer
- 'null'
format: int32
optional:
type:
- boolean
- 'null'
items:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/KeyToPath'
required:
- name
ContainerPort:
type: object
properties:
name:
type: string
containerPort:
type: integer
protocol:
$ref: '#/components/schemas/Protocol'
required:
- containerPort
URIScheme:
type: string
enum:
- HTTP
- HTTPS
EmptyDirVolumeSource:
type: object
properties:
medium:
$ref: '#/components/schemas/StorageMedium'
sizeLimit:
type:
- string
- 'null'
GRPCAction:
type: object
properties:
port:
type: integer
format: int32
minimum: 1
maximum: 65535
service:
type:
- string
- 'null'
required:
- port
SecretVolumeSource:
type: object
properties:
secretName:
type: string
defaultMode:
type:
- integer
- 'null'
format: int32
optional:
type:
- boolean
- 'null'
items:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/KeyToPath'
required:
- secretName
SleepAction:
type: object
properties:
seconds:
type: integer
format: int64
minimum: 0
required:
- seconds
ResourceRequirements:
type: object
properties:
limits:
$ref: '#/components/schemas/ResourceList'
requests:
$ref: '#/components/schemas/ResourceList'
Protocol:
type: string
enum:
- TCP
- UDP
- SCTP
LifecycleHandler:
type: object
properties:
exec:
$ref: '#/components/schemas/ExecAction'
httpGet:
$ref: '#/components/schemas/HTTPGetAction'
tcpSocket:
$ref: '#/components/schemas/TCPSocketAction'
sleep:
$ref: '#/components/schemas/SleepAction'
PullPolicy:
type: string
enum:
- Always
- IfNotPresent
- Never
TCPSocketAction:
type: object
properties:
port:
type: integer
format: int32
minimum: 1
maximum: 65535
host:
type:
- string
- 'null'
required:
- port
CreateSidecar:
type: object
properties:
name:
type: string
example: my-sidecar
image:
type: string
example: nginx:latest
imagePullPolicy:
$ref: '#/components/schemas/PullPolicy'
command:
type: array
items:
type: string
example:
- /bin/sh
- -c
- nginx
args:
type: array
items:
type: string
example:
- -c
- nginx
env:
type: array
items:
$ref: '#/components/schemas/EnvVar'
resources:
$ref: '#/components/schemas/ResourceRequirements'
ports:
type: array
items:
$ref: '#/components/schemas/ContainerPort'
volumeMounts:
type: array
items:
$ref: '#/components/schemas/VolumeMount'
volumes:
type: array
items:
$ref: '#/components/schemas/Volume'
livenessProbe:
$ref: '#/components/schemas/Probe'
readinessProbe:
$ref: '#/components/schemas/Probe'
startupProbe:
$ref: '#/components/schemas/Probe'
lifecycle:
$ref: '#/components/schemas/Lifecycle'
required:
- name
- image
SecretKeySelector:
type: object
properties:
name:
type: string
key:
type: string
required:
- name
- key
Lifecycle:
type: object
properties:
preStop:
$ref: '#/components/schemas/LifecycleHandler'
postStart:
$ref: '#/components/schemas/LifecycleHandler'
ConfigMapKeySelector:
type: object
properties:
name:
type: string
key:
type: string
required:
- name
- key
Volume:
type: object
properties:
name:
type: string
configMap:
$ref: '#/components/schemas/ConfigMapVolumeSource'
secret:
$ref: '#/components/schemas/SecretVolumeSource'
emptyDir:
$ref: '#/components/schemas/EmptyDirVolumeSource'
required:
- name
StorageMedium:
type: string
MountPropagationMode:
type: string
enum:
- None
- HostToContainer
- Bidirectional
ExecAction:
type: object
properties:
command:
type: array
items:
type: string
required:
- command
ResourceList:
type: object
properties:
cpu:
type: string
memory:
type: string
additionalProperties:
type: string
Sidecars:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Sidecar'
endCursor:
type:
- string
- 'null'
required:
- items
- endCursor
HTTPHeader:
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- value
VolumeMount:
type: object
properties:
name:
type: string
mountPath:
type: string
readOnly:
type: boolean
subPath:
type: string
subPathExpr:
type: string
mountPropagation:
$ref: '#/components/schemas/MountPropagationMode'
required:
- name
- mountPath
HTTPGetAction:
type: object
properties:
path:
type: string
port:
type: integer
format: int32
minimum: 1
maximum: 65535
host:
type:
- string
- 'null'
scheme:
$ref: '#/components/schemas/URIScheme'
httpHeaders:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/HTTPHeader'
required:
- port
KeyToPath:
type: object
properties:
key:
type: string
path:
type: string
mode:
type:
- integer
- 'null'
format: int32
required:
- key
- path
Deleted:
type: object
properties:
deleted:
type: boolean
deletedAt:
type:
- string
- 'null'
format: date-time
default: null
required:
- deleted
- deletedAt
Created:
type: object
properties:
id:
type: string
format: uuid
createdAt:
type: string
format: date-time
required:
- id
- createdAt
Probe:
type: object
properties:
exec:
$ref: '#/components/schemas/ExecAction'
httpGet:
$ref: '#/components/schemas/HTTPGetAction'
tcpSocket:
$ref: '#/components/schemas/TCPSocketAction'
grpc:
$ref: '#/components/schemas/GRPCAction'
initialDelaySeconds:
type:
- integer
- 'null'
format: int32
minimum: 0
timeoutSeconds:
type:
- integer
- 'null'
format: int32
minimum: 0
periodSeconds:
type:
- integer
- 'null'
format: int32
minimum: 0
successThreshold:
type:
- integer
- 'null'
format: int32
minimum: 0
failureThreshold:
type:
- integer
- 'null'
format: int32
minimum: 0
terminationGracePeriodSeconds:
type:
- integer
- 'null'
format: int64
minimum: 0
securitySchemes:
user:
type: http
scheme: bearer
project:
name: X-Project-Token
type: apiKey
in: header
auth0:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://sso.calyptia.com/oauth/token
scopes: {}
authorizationCode:
authorizationUrl: https://sso.calyptia.com/authorize
tokenUrl: https://sso.calyptia.com/oauth/token
scopes: {}