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

The processing_rule_template API from Calyptia — 4 operation(s) for processing_rule_template.

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

This API exposes 9 operations across 4 paths, and defines 13 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}.

9 operations 4 paths 13 schemas 2 DELETE3 GET2 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_template 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 9

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

processing_rule_template 9
POST
/v1/projects/{projectID}/processing_rule_templatesdeprecated
Create processing rule template
createProcessingRuleTemplateV1 1 param body → 201
GET
/v1/projects/{projectID}/processing_rule_templatesdeprecated
Processing rule templates
processingRuleTemplatesV1 4 params → 200
PATCH
/v1/processing_rule_templates/{templateID}deprecated
Update processing rule template
updateProcessingRuleTemplateV1 1 param body → 200
DELETE
/v1/processing_rule_templates/{templateID}deprecated
Delete processing rule template
deleteProcessingRuleTemplateV1 1 param → 200
POST
/v2/projects/{projectID}/processing_rule_templates
Create processing rule template
createProcessingRuleTemplate 1 param body → 201
GET
/v2/projects/{projectID}/processing_rule_templates
Processing rule templates
processingRuleTemplates 4 params → 200
GET
/v2/processing_rule_templates/{templateID}
Processing rule template
processingRuleTemplate 1 param → 200
PATCH
/v2/processing_rule_templates/{templateID}
Update processing rule template
updateProcessingRuleTemplate 1 param body → 200
DELETE
/v2/processing_rule_templates/{templateID}
Delete processing rule template
deleteProcessingRuleTemplate 1 param → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ProcessingRuleTemplateV1 (9 properties), ProcessingRuleTemplate (7 properties), UpdateProcessingRuleTemplateV1 (5 properties), CreateProcessingRuleTemplateV1 (5 properties). Each schema is shown below with its type and property counts.

ProcessingRuleTemplates
object
3 properties 3 required
StaticProcessingRuleTemplateV1
object
A static processing rule template is a template that is not editable. It's a template that is provided by Calyptia.
2 properties
CreateProcessingRuleTemplate
object
3 properties 3 required
Created
object
2 properties 2 required
ProcessingRuleDefV1
object
4 properties
Deleted
object
2 properties 2 required
UpdateProcessingRuleTemplateV1
object
5 properties
ProcessingRuleTemplate
object
7 properties 7 required
Updated
object
1 property 1 required
ProcessingRuleTemplateV1
object
9 properties
UpdateProcessingRuleTemplate
object
3 properties
ProcessingRuleTemplatesV1
object
4 properties 4 required
CreateProcessingRuleTemplateV1
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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