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

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

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

Tagged areas include processing_rule. 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 14 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 14 schemas 1 DELETE2 GET1 PATCH2 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 processing_rule 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, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

processing_rule 6
POST
/v1/pipelines/{pipelineID}/processing_rulesdeprecated
Create a processing rule
createProcessingRuleV1 1 param body → 201
GET
/v1/pipelines/{pipelineID}/processing_rulesdeprecated
Processing rules
processingRulesV1 3 params → 200
GET
/v1/processing_rules/{processingRuleID}deprecated
Processing rule
processingRuleV1 1 param → 200
PATCH
/v1/processing_rules/{processingRuleID}deprecated
Update processing rule
updateProcessingRuleV1 1 param body → 200
DELETE
/v1/processing_rules/{processingRuleID}deprecated
Delete processing rule
deleteProcessingRuleV1 1 param → 204
POST
/v1/preview_processing_ruledeprecated
Preview processing rule
previewProcessingRuleV1 body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ProcessingRuleV1 (10 properties), RuleActionV1 (8 properties), CreateProcessingRuleV1 (4 properties), UpdateProcessingRuleV1 (4 properties). Each schema is shown below with its type and property counts.

RuleActionV1
object
8 properties 4 required
UpdateProcessingRuleV1
object
4 properties
CreateProcessingRuleV1
object
4 properties 4 required
LogAttr
object
2 properties 2 required
ProcessingRuleLanguageV1
string
LogSelectorV1
object
3 properties 3 required
LogSelectorOpKindV1
string
RuleActionKindV1
string
CreatedProcessingRuleV1
object
4 properties 4 required
FluentBitLog
array
Represents a fluent-bit log. It's an array with 2 items: - 0 being a unix timestamp with nanoseconds fraction. - 1 being an object of string key-values.
ProcessingRuleV1
object
10 properties 10 required
UpdatedProcessingRuleV1
object
1 property 1 required
PreviewProcessingRuleV1
object
3 properties 3 required
LogSelectorKindV1
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-processing-rule-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