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

The config_validator_v2 API from Calyptia — 1 operation(s) for config_validator_v2.

Calyptia config_validator_v2 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_validator_v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 4 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}.

1 operations 1 paths 4 schemas 1 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_validator_v2 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

config_validator_v2 1
POST
/v1/config_validate_v2deprecated
Validate configuration on the v2 endpoint of the service
validateConfigV2 body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ConfigValidityV2Property (4 properties), ConfigValidityV2Runtime (2 properties), ValidatingConfig (1 property), ValidatedConfigV2 (1 property). Each schema is shown below with its type and property counts.

ValidatedConfigV2
object
Validation V2 config response.
1 property 1 required
ConfigValidityV2Property
object
Property of the validated configuration section
4 properties 4 required
ConfigValidityV2Runtime
object
Runtime errors for the validated configuration.
2 properties 2 required
ValidatingConfig
object
Validating configuration request body.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-config-validator-v2-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 core_instance API
Calyptia core_instance_check API