Calyptia pipeline API
The pipeline API from Calyptia — 5 operation(s) for pipeline.
The pipeline API from Calyptia — 5 operation(s) for pipeline.
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-pipeline-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 Pipeline 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: pipeline
paths:
/v1/aggregators/{aggregatorID}/pipelines:
parameters:
- schema:
type: string
format: uuid
name: aggregatorID
in: path
required: true
post:
tags:
- pipeline
summary: Create pipeline
operationId: createPipeline
description: 'Create pipeline within a core instance.
The pipeline name must be unique within the core instance.
The resource profile must exist already. If you don''t provide one, it will default to "best-effort-low-resource".
Use them to easily deploy configured agents to the core instance.'
security:
- user: []
- project: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePipeline'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedPipeline'
get:
deprecated: true
tags:
- pipeline
summary: Pipelines (deprecated)
operationId: pipelines
description: Pipelines from a core instance (deprecated).
security:
- user: []
- project: []
parameters:
- schema:
type: integer
minimum: 0
in: query
name: last
description: Last pipelines.
- schema:
type: string
in: query
name: before
description: Pipelines before the given cursor.
- schema:
type: string
in: query
name: name
description: Name matching pipelines.
- schema:
type: string
example: tagone AND tagtwo
in: query
name: tags_query
description: Tag query.
- schema:
type: string
enum:
- classic
- json
- yaml
in: query
name: config_format
description: Desired output config format.
- schema:
type: string
enum:
- ports
- files
- secrets
in: query
name: include
description: Include all ports, secrets and files objects in the pipeline.
- name: exclude_internal
schema:
type: boolean
in: query
description: Exclude internal pipelines (health-check).
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
example: </v1/aggregators/foo/pipelines?before=bar>; rel="next"
description: RFC5988 with `rel="next"`.
links:
NextPipelinesPage:
operationId: pipelines
parameters:
before: $response.header.Link#rel=next
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pipeline'
delete:
tags:
- pipeline
summary: Delete Pipelines
operationId: deletePipelines
description: Delete pipelines from a core instance.
security:
- user: []
- project: []
parameters:
- schema:
type: array
items:
type: string
format: uuid
in: query
name: pipeline_id
description: List of pipeline IDs to delete.
responses:
'204':
description: Deleted
/v1/core_instances/{coreInstanceID}/pipelines:
parameters:
- name: coreInstanceID
schema:
type: string
format: uuid
in: path
description: Parent core instance ID.
required: true
get:
operationId: pipelinesV2
tags:
- pipeline
summary: Pipelines
description: Pipelines from a core instance with backward pagination.
security:
- user: []
- project: []
parameters:
- name: last
schema:
type: integer
minimum: 0
in: query
description: Limit to the last pipelines.
- name: before
schema:
type: string
in: query
description: Paginate pipelines before the given cursor.
- name: kind
schema:
$ref: '#/components/schemas/PipelineKind'
in: query
description: Filter pipelines by kind.
- name: name
schema:
type: string
in: query
description: Filter pipelines by name.
- name: tags_query
schema:
type: string
example: tagone AND tagtwo
in: query
description: Filter pipelines by giving a tags query.
- name: config_format
schema:
type: string
enum:
- classic
- json
- yaml
in: query
description: Desired output config format.
- name: include
schema:
type: array
items:
type: string
enum:
- ports
- files
- secrets
in: query
description: Whether to include ports, secrets and files objects in the pipeline.
- name: exclude_internal
schema:
type: boolean
in: query
description: Exclude internal pipelines (health-check).
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Pipelines'
/v1/projects/{projectID}/aggregator_pipelines:
parameters:
- schema:
type: string
format: uuid
name: projectID
in: path
required: true
get:
deprecated: true
tags:
- pipeline
summary: Project pipelines (deprecated)
operationId: projectPipelines
description: Pipelines from a project (deprecated).
security:
- user: []
- project: []
parameters:
- schema:
type: integer
minimum: 0
in: query
name: last
description: Last pipelines.
- schema:
type: string
in: query
name: name
description: Name matching pipelines.
- schema:
type: string
example: tagone AND tagtwo
in: query
name: tags_query
description: Tag query.
- schema:
type: string
enum:
- classic
- json
- yaml
in: query
name: config_format
description: Desired output config format.
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pipeline'
/v1/projects/{projectID}/pipelines:
parameters:
- name: projectID
schema:
type: string
format: uuid
in: path
description: Parent project ID.
required: true
get:
operationId: projectPipelinesV2
tags:
- pipeline
summary: Project pipelines
description: Pipelines from a project with backward pagination.
security:
- user: []
- project: []
parameters:
- name: last
schema:
type: integer
minimum: 0
in: query
description: Limit to the last pipelines.
- name: before
schema:
type: string
in: query
description: Paginate pipelines before the given cursor.
- name: kind
schema:
$ref: '#/components/schemas/PipelineKind'
in: query
description: Filter pipelines by kind.
- name: name
schema:
type: string
in: query
description: Filter pipelines by name.
- name: tags_query
schema:
type: string
example: tagone AND tagtwo
in: query
description: Filter pipelines by giving a tags query.
- name: config_format
schema:
type: string
enum:
- classic
- json
- yaml
in: query
description: Desired output config format.
- name: include
schema:
type: array
items:
type: string
enum:
- ports
- files
- secrets
in: query
description: Whether to include ports, secrets and files objects in the pipeline.
- name: exclude_internal
schema:
type: boolean
in: query
description: Exclude internal pipelines (health-check).
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Pipelines'
/v1/aggregator_pipelines/{pipelineID}:
parameters:
- schema:
type: string
format: uuid
name: pipelineID
in: path
required: true
get:
tags:
- pipeline
summary: Pipeline
operationId: pipeline
description: Pipeline by ID.
security:
- user: []
- project: []
parameters:
- schema:
type: string
enum:
- classic
- json
- yaml
in: query
name: config_format
description: Desired output config format.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Pipeline'
patch:
tags:
- pipeline
summary: Update pipeline
operationId: updatePipeline
description: Update pipeline by its ID.
security:
- user: []
- project: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePipeline'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatedPipeline'
delete:
tags:
- pipeline
summary: Delete pipeline
operationId: deletePipeline
description: Delete pipeline by its ID.
security:
- user: []
- project: []
responses:
'204':
description: No Content
components:
schemas:
PipelineKind:
type: string
default: deployment
enum:
- deployment
- daemonSet
- statefulSet
Toleration:
type: object
properties:
key:
type: string
operator:
$ref: '#/components/schemas/TolerationOperator'
value:
type: string
effect:
$ref: '#/components/schemas/TolerationEffect'
tolerationSeconds:
type:
- integer
- 'null'
format: int64
required:
- key
- operator
- effect
CreatePipelineFile:
description: Create pipeline file request body.
type: object
properties:
name:
type: string
example: newfile
contents:
type: string
format: byte
encrypted:
type: boolean
required:
- name
- contents
- encrypted
UpdatePipeline:
description: Update pipeline request body.
type: object
properties:
name:
type:
- string
- 'null'
description: DNS label format as of defined on RFC1123
example: new-pipeline
default: null
kind:
type: string
description: Kind of deployment used when deploying this pipeline
default: deployment
enum:
- daemonSet
- deployment
deploymentStrategy:
type: string
description: 'The deployment strategy to use when creating or updating changes to this pipeline.
'
default: rollingupdate
enum:
- recreate
- rollingupdate
- hotReload
replicasCount:
type:
- integer
- 'null'
minimum: 0
default: null
rawConfig:
type:
- string
- 'null'
default: null
configFormat:
type:
- string
- 'null'
enum:
- classic
- json
- yaml
default: null
image:
type:
- string
- 'null'
example: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2
default: null
secrets:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/UpdatePipelineSecret'
files:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/UpdatePipelineFile'
resourceProfile:
type:
- string
- 'null'
example: my-resource-profile
default: null
noAutoCreateEndpointsFromConfig:
type:
- boolean
- 'null'
default: null
noAutoCreateChecksFromConfig:
type:
- boolean
- 'null'
default: null
autoCreatePortsFromConfig:
type:
- boolean
- 'null'
default: null
deprecated: true
autoCreateChecksFromConfig:
type:
- boolean
- 'null'
default: null
deprecated: true
skipConfigValidation:
type: boolean
default: false
checksBeforeDeploying:
type:
- boolean
- 'null'
default: null
description: 'If set to true:
If all checks associated with the pipeline run successfully, the status of
the pipeline will be switched to CHECKS_OK and the deployment will be executed.
If any of the checks associated with the pipeline fails, the status of
the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline
will be blocked.
If set to false (default):
If all checks associated with the pipeline run successfully, the status of
the pipeline will be switched to CHECKS_OK and the deployment will be executed.
If any of the checks associated with the pipeline fails, the status of
the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline
'
status:
type:
- string
- 'null'
default: null
enum:
- NEW
- FAILED
- STARTING
- STARTED
- SCALING
- CHECKS_OK
- CHECKS_FAILED -
portKind:
$ref: '#/components/schemas/PipelinePortKind'
default: null
events:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/PipelineEvent'
metadata:
type:
- object
- 'null'
default: null
additionalProperties: true
minReplicas:
type:
- integer
- 'null'
default: null
maxReplicas:
type:
- integer
- 'null'
default: null
scaleUpType:
$ref: '#/components/schemas/ScalePolicy'
default: null
scaleUpValue:
type:
- integer
- 'null'
default: null
scaleUpPeriodSeconds:
type:
- integer
- 'null'
default: null
scaleDownType:
$ref: '#/components/schemas/ScalePolicy'
default: null
scaleDownValue:
type:
- integer
- 'null'
default: null
scaleDownPeriodSeconds:
type:
- integer
- 'null'
default: null
utilizationCPUAverage:
type:
- integer
- 'null'
default: null
utilizationMemoryAverage:
type:
- integer
- 'null'
default: null
storageClass:
type:
- string
- 'null'
description: Represents the storageClass for PVC templates
default: null
labels:
type:
- object
- 'null'
default: null
additionalProperties:
type: string
affinity:
$ref: '#/components/schemas/Affinity'
topologySpreadConstraints:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TopologySpreadConstraint'
terminationGracePeriodSeconds:
type:
- integer
- 'null'
format: int64
minimum: 0
lifecycle:
$ref: '#/components/schemas/Lifecycle'
pvcRetentionPolicy:
$ref: '#/components/schemas/PVCRetentionPolicy'
description: Defines what happens to PVCs when StatefulSets are scaled or deleted (K8s 1.23+)
AgentConfig:
type: object
description: Agent configuration history entry.
properties:
id:
type: string
format: uuid
rawConfig:
type: string
createdAt:
type: string
format: date-time
required:
- id
- rawConfig
- createdAt
TolerationOperator:
type: string
enum:
- Equal
- Exists
URIScheme:
type: string
enum:
- HTTP
- HTTPS
DeploymentStrategy:
type: string
description: 'The deployment strategy to use when creating or updating changes to this pipeline.
'
default: rollingupdate
enum:
- recreate
- rollingupdate
- hotReload
Pair:
type: object
properties:
key:
type: string
example: name
value:
anyOf:
- type: integer
- type: number
- type: boolean
- type: string
- type: array
items:
type: string
example: dummy
required:
- key
- value
Pipeline:
type: object
description: Pipeline model.
properties:
id:
type: string
format: uuid
name:
type: string
description: DNS label format as of defined on RFC1123
example: my-pipeline
kind:
$ref: '#/components/schemas/PipelineKind'
config:
$ref: '#/components/schemas/PipelineConfig'
configSections:
type: array
items:
$ref: '#/components/schemas/ConfigSection'
status:
$ref: '#/components/schemas/PipelineStatus'
resourceProfile:
$ref: '#/components/schemas/ResourceProfile'
deploymentStrategy:
$ref: '#/components/schemas/DeploymentStrategy'
tracingEnabled:
type: boolean
default: false
waitForChecksBeforeDeploying:
type: boolean
default: false
image:
type:
- string
- 'null'
example: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2
default: null
replicasCount:
type: integer
minimum: 0
replicasCountPrev:
type: integer
description: the previous replica set counter
minimum: 0
checksTotal:
type: integer
minimum: 0
description: total number of checks associated with the pipeline.
checksOK:
type: integer
minimum: 0
description: total number of checks with ok status.
checksRunning:
type: integer
minimum: 0
description: total number of checks with running status.
tags:
type:
- array
- 'null'
default: null
uniqueItems: true
items:
type: string
metadata:
type:
- object
- 'null'
default: null
additionalProperties: true
secrets:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/PipelineSecret'
files:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/PipelineFile'
ports:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/PipelinePort'
minReplicas:
type: integer
description: minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
maxReplicas:
type: integer
description: maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.
scaleUpType:
$ref: '#/components/schemas/ScalePolicy'
scaleUpValue:
type: integer
description: value contains the amount of change which is permitted by the policy.
scaleUpPeriodSeconds:
type: integer
description: ScaleUpPeriodSeconds specifies the window of time for which the policy should hold true.
scaleDownType:
$ref: '#/components/schemas/ScalePolicy'
scaleDownValue:
type: integer
description: value contains the amount of change which is permitted by the policy.
scaleDownPeriodSeconds:
type: integer
description: ScaleUpPeriodSeconds specifies the window of time for which the policy should hold true.
utilizationCPUAverage:
type: integer
description: UtilizationCPUAverage defines the target value for average CPU utilization
utilizationMemoryAverage:
type: integer
description: UtilizationMemoryAverage defines the target value for average CPU utilization
storageClass:
type:
- string
- 'null'
description: Represents the storageClass for PVC templates
default: null
pvcRetentionPolicy:
$ref: '#/components/schemas/PVCRetentionPolicy'
portKind:
$ref: '#/components/schemas/PipelinePortKind'
labels:
type:
- object
- 'null'
default: null
additionalProperties: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
error:
type:
- string
- 'null'
default: null
description: Contains any error that occurred when rendering the pipeline with config sections
required:
- id
- name
- kind
- config
- configSections
- image
- status
- resourceProfile
- deploymentStrategy
- tracingEnabled
- waitForChecksBeforeDeploying
- replicasCount
- replicasCountPrev
- tags
- metadata
- checksTotal
- checksOK
- checksRunning
- portKind
- labels
- createdAt
- updatedAt
- minReplicas
- maxReplicas
- scaleUpType
- scaleUpValue
- scaleUpPeriodSeconds
- scaleDownType
- scaleDownValue
- scaleDownPeriodSeconds
- utilizationCPUAverage
- utilizationMemoryAverage
PipelinePortKind:
type: string
description: The kind/type of the service associated to this port.
default: LoadBalancer
enum:
- LoadBalancer
- ClusterIP
- NodePort
ConfigFormat:
type: string
enum:
- classic
- yaml
- json
default: classic
example: yaml
PipelineFile:
type: object
description: Pipeline file model.
properties:
id:
type: string
format: uuid
processingRuleID:
type:
- string
- 'null'
format: uuid
default: null
name:
type: string
example: myfile
contents:
type: string
format: byte
encrypted:
type: boolean
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- processingRuleID
- name
- contents
- encrypted
- createdAt
- updatedAt
SleepAction:
type: object
properties:
seconds:
type: integer
format: int64
minimum: 0
required:
- seconds
UpdatePipelineFile:
description: Update pipeline file request body.
type: object
properties:
name:
type:
- string
- 'null'
example: newfile
default: null
contents:
type:
- string
- 'null'
format: byte
default: null
encrypted:
type:
- boolean
- 'null'
default: null
Pairs:
type: array
items:
$ref: '#/components/schemas/Pair'
CreatePipeline:
description: Create pipeline request body.
type: object
properties:
name:
type: string
description: DNS label format as of defined on RFC1123
example: new-pipeline
kind:
$ref: '#/components/schemas/PipelineKind'
replicasCount:
type: integer
minimum: 0
rawConfig:
type: string
configFormat:
$ref: '#/components/schemas/ConfigFormat'
image:
type:
- string
- 'null'
example: ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2
default: null
secrets:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/CreatePipelineSecret'
files:
type:
- array
- 'null'
default: null
items:
$ref: '#/components/schemas/CreatePipelineFile'
resourceProfile:
type: string
example: my-resource-profile
noAutoCreateChecksFromConfig:
type: boolean
default: false
description: 'If true, no Pipeline checks will be auto-generated from
the configuration.
'
autoCreateChecksFromConfig:
type: boolean
deprecated: true
default: false
description: 'If true, this will automatically create a set of Pipeline checks
to validate that the configured output services are reachable.
'
waitForChecksBeforeDeploying:
type: boolean
default: false
description: 'If set to true:
If all checks associated with the pipeline run successfully, the status of
the pipeline will be switched to CHECKS_OK and the deployment will be executed.
If any of the checks associated with the pipeline fails, the status of
the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline
will be blocked.
If set to false (default):
If all checks associated with the pipeline run successfully, the status of
the pipeline will be switched to CHECKS_OK and the deployment will be executed.
If any of the checks associated with the pipeline fails, the status of
the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline
will be executed.
'
noAutoCreateEndpointsFromConfig:
type: boolean
default: false
description: if true, no ports will be automatically generated from the configuration.
autoCreatePortsFromConfig:
type: boolean
default: false
deprecated: true
skipConfigValidation:
type: boolean
metadata:
type:
- object
- 'null'
default: null
additionalProperties: true
portKind:
$ref: '#/components/schemas/PipelinePortKind'
minReplicas:
type: integer
default: 0
maxReplicas:
type: integer
default: 0
scaleUpType:
$ref: '#/components/schemas/ScalePolicy'
scaleUpValue:
type: integer
default: 0
scaleUpPeriodSeconds:
type: integer
default: 0
scaleDownType:
$ref: '#/components/schemas/ScalePolicy'
scaleDownValue:
type: integer
default: 0
scaleDownPeriodSeconds:
type: integer
default: 0
utilizationCPUAverage:
type: integer
default: 0
utilizationMemoryAverage:
type: integer
default: 0
labels:
type:
- object
- 'null'
default: null
additionalProperties:
type: string
affinity:
$ref: '#/components/schemas/Affinity'
topologySpreadConstraints:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TopologySpreadConstraint'
tolerations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Toleration'
terminationGracePeriodSeconds:
type:
- integer
- 'null'
format: int64
minimum: 0
lifecycle:
$ref: '#/components/schemas/Lifecycle'
storageClass:
type:
- string
- 'null'
description: Represents the storageClass for PVC templates
pvcRetentionPolicy:
$ref: '#/components/schemas/PVCRetentionPolicy'
required:
- name
- replicasCount
- rawConfig
- image
- secrets
- files
- resourceProfile
- skipConfigValidation
- portKind
- minReplicas
- maxReplicas
- scaleUpType
- scaleUpValue
- scaleUpPeriodSeconds
- scaleDownType
- scaleDownValue
- scaleDownPeriodSeconds
- utilizationCPUAverage
- utilizationMemoryAverage
LifecycleHandler:
type: object
properties:
exec:
$ref: '#/components/schemas/ExecAction'
httpGet:
$ref: '#/components/schemas/HTTPGetAction'
tcpSocket:
$ref: '#/components/schemas/TCPSocketAction'
sleep:
$ref: '#/components/schemas/SleepAction'
ResourceProfile:
type: object
description: Resource profile model.
properties:
id:
type: string
format: uuid
name:
type: string
example: my-resource-profile
storageMaxChunksUp:
type: integer
format: int32
storageSyncFull:
type: boolean
storageBacklogMemLimit:
type: string
example: 1Mi
storageVolumeSize:
type: string
example: 2Mi
storageMaxChunksPause:
type: boolean
cpuBufferWorkers:
type: integer
format: int32
cpuLimit:
type: string
example: 3Mi
cpuRequest:
type: string
example: 4Mi
memoryLimit:
type: string
example: 5Mi
memoryRequest:
type:
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/calyptia/refs/heads/main/openapi/calyptia-pipeline-api-openapi.yml