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

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

Calyptia pipeline_port 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_port. 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 5 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 5 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 pipeline_port 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.

pipeline_port 5
POST
/v1/aggregator_pipelines/{pipelineID}/ports
Create pipeline port
createPipelinePort 1 param body → 201
GET
/v1/aggregator_pipelines/{pipelineID}/ports
Pipeline ports
pipelinePorts 2 params → 200
GET
/v1/pipeline_ports/{portID}
Pipeline port
pipelinePort 1 param → 200
PATCH
/v1/pipeline_ports/{portID}
Update pipeline port
updatePipelinePort 1 param body → 204
DELETE
/v1/pipeline_ports/{portID}
Delete pipeline port
deletePipelinePort 1 param → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PipelinePort (11 properties), CreatedPipelinePort (6 properties), UpdatePipelinePort (5 properties), CreatePipelinePort (5 properties). Each schema is shown below with its type and property counts.

CreatePipelinePort
object
Create pipeline port request body.
5 properties 4 required
CreatedPipelinePort
object
Created pipeline port response body.
6 properties 5 required
UpdatePipelinePort
object
Update pipeline port request body.
5 properties
PipelinePortKind
string
The kind/type of the service associated to this port.
PipelinePort
object
Pipeline port model.
11 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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