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

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

Calyptia pipeline_check 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_check. 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 6 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 6 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_check 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_check 5
POST
/v1/pipelines/{pipelineID}/checks
Create pipeline check
createPipelineCheck 1 param body → 201
GET
/v1/pipelines/{pipelineID}/checks
Pipeline checks
pipelineChecks 3 params → 200
GET
/v1/pipeline_checks/{checkID}
Pipeline check
pipelineCheck 1 param → 200
PATCH
/v1/pipeline_checks/{checkID}
Update pipeline check
updatePipelineCheck 1 param body → 204
DELETE
/v1/pipeline_checks/{checkID}
Delete pipeline check
deletePipelineCheck 1 param → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PipelineCheck (8 properties), CreatePipelineCheck (5 properties), UpdatePipelineCheck (5 properties), CreatedPipelineCheck (2 properties). Each schema is shown below with its type and property counts.

CreatedPipelineCheck
object
Created pipeline check response body.
2 properties 2 required
UpdatePipelineCheck
object
Update pipeline check request body.
5 properties
PipelineCheck
object
Pipeline check model.
8 properties 8 required
PipelinePortProtocol
string
Valid protocol types defined for a pipelines.
CreatePipelineCheck
object
Create pipeline check request body.
5 properties 3 required
CheckStatus
string
The status of a check.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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