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

The config_section API from Calyptia — 3 operation(s) for config_section.

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

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

This API exposes 6 operations across 3 paths, and defines 8 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}.

6 operations 3 paths 8 schemas 1 DELETE2 GET2 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 config_section 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 6

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

config_section 6
POST
/v1/projects/{projectID}/config_sections
Create config section
createConfigSection 1 param body → 201
GET
/v1/projects/{projectID}/config_sections
Config sections
configSections 4 params → 200
GET
/v1/config_sections/{configSectionID}
Config section
configSection 1 param → 200
PATCH
/v1/config_sections/{configSectionID}
Update config section
updateConfigSection 1 param body → 200
DELETE
/v1/config_sections/{configSectionID}
Delete config section
deleteConfigSection 1 param → 204
PATCH
/v1/pipelines/{pipelineID}/config_section_set
Update config section set
updateConfigSectionSet 1 param body → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ConfigSection (7 properties), CreateConfigSection (3 properties), Pair (2 properties), UpdateConfigSection (2 properties). Each schema is shown below with its type and property counts.

ConfigSectionKind
string
Pairs
array
UpdatedConfigSection
object
1 property 1 required
ConfigSection
object
7 properties 7 required
CreatedConfigSection
object
2 properties 2 required
UpdateConfigSection
object
2 properties
Pair
object
2 properties 2 required
CreateConfigSection
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-config-section-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_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API
Calyptia core_instance_check API