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

The pipeline API from Calyptia — 5 operation(s) for pipeline.

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

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

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

9 operations 5 paths 46 schemas 2 DELETE5 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 pipeline 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 9

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

pipeline 9
POST
/v1/aggregators/{aggregatorID}/pipelines
Create pipeline
createPipeline 1 param body → 201
GET
/v1/aggregators/{aggregatorID}/pipelinesdeprecated
Pipelines (deprecated)
pipelines 8 params → 200
DELETE
/v1/aggregators/{aggregatorID}/pipelines
Delete Pipelines
deletePipelines 2 params → 204
GET
/v1/core_instances/{coreInstanceID}/pipelines
Pipelines
pipelinesV2 9 params → 200
GET
/v1/projects/{projectID}/aggregator_pipelinesdeprecated
Project pipelines (deprecated)
projectPipelines 5 params → 200
GET
/v1/projects/{projectID}/pipelines
Project pipelines
projectPipelinesV2 9 params → 200
GET
/v1/aggregator_pipelines/{pipelineID}
Pipeline
pipeline 2 params → 200
PATCH
/v1/aggregator_pipelines/{pipelineID}
Update pipeline
updatePipeline 1 param body → 200
DELETE
/v1/aggregator_pipelines/{pipelineID}
Delete pipeline
deletePipeline 1 param → 204

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Pipeline (38 properties), UpdatePipeline (37 properties), CreatePipeline (35 properties), ResourceProfile (14 properties). Each schema is shown below with its type and property counts.

ConfigSectionKind
string
TolerationEffect
string
URIScheme
string
DeploymentStrategy
string
The deployment strategy to use when creating or updating changes to this pipeline.
UnsatisfiableConstraintAction
string
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
UpdatePipelineFile
object
Update pipeline file request body.
3 properties
PipelinePort
object
Pipeline port model.
11 properties 11 required
PipelineStatus
object
Pipeline status history entry.
5 properties 4 required
LifecycleHandler
object
4 properties
TCPSocketAction
object
2 properties 1 required
PipelineCheck
object
Pipeline check model.
8 properties 8 required
PipelineConfig
object
Pipeline configuration history entry.
4 properties 4 required
UpdatePipelineSecret
object
Update pipeline secret request body.
2 properties
UpdatedPipeline
object
Updated pipeline response body.
4 properties
AgentConfig
object
Agent configuration history entry.
3 properties 3 required
NodeSelectorOperator
string
ScalePolicy
string
PipelinePortProtocol
string
Valid protocol types defined for a pipelines.
ConfigFormat
string
CheckStatus
string
The status of a check.
Toleration
object
5 properties 3 required
Lifecycle
object
2 properties
CreatePipelineSecret
object
Create pipeline secret request body.
2 properties 2 required
ConfigSection
object
7 properties 7 required
HTTPHeader
object
2 properties 2 required
PipelineKind
string
ResourceProfile
object
Resource profile model.
14 properties 14 required
Pipelines
object
3 properties 3 required
Pipeline
object
Pipeline model.
38 properties 32 required
PipelineEvent
object
Pipeline Status event.
4 properties 3 required
Affinity
object
3 properties 3 required
SleepAction
object
1 property 1 required
PipelineSecret
object
Pipeline secret model.
5 properties 5 required
HTTPGetAction
object
5 properties 1 required
CreatedPipeline
object
Created pipeline response body.
10 properties
TopologySpreadConstraint
object
5 properties 5 required
CreatePipeline
object
Create pipeline request body.
35 properties 19 required
ExecAction
object
1 property 1 required
TolerationOperator
string
CreatePipelineFile
object
Create pipeline file request body.
3 properties 3 required
Pair
object
2 properties 2 required
Pairs
array
UpdatePipeline
object
Update pipeline request body.
37 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-pipeline-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