LogoLogo
Support PortalCalyptia CoreContact Us
Calyptia Core API
Calyptia Core API
  • Specification
  • About
  • API reference
    • Verification email
    • Projects
      • Tokens
      • Members
      • Invite
      • Agents
      • Aggregators
      • Core instances
      • Aggregator pipelines
      • Pipelines
      • Environments
      • Metrics
      • Config sections
      • Fleets
        • Status
      • Aws contracts
      • Processing rule templates
      • Saml mappings
    • Project tokens
    • Members
    • Join project
    • Agents
      • Config history
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
      • Errors
    • Aggregators
      • Ping
      • Resource profiles
      • Pipelines
      • Pipelines metrics
    • Core instance files
    • Core instance secrets
    • Resource profiles
    • Aggregator pipelines
      • Config history
      • Status history
      • Files
      • Secrets
      • Ports
    • Pipeline files
    • Pipeline logs
    • Pipeline checks
    • Core instance checks
    • Ingest checks
    • Pipeline secrets
    • Pipeline ports
    • Config validate
    • Config validate v2
    • Environments
    • Pipeline metrics
    • Aggregator metrics
    • Cluster objects
    • Trace sessions
      • Records
    • Config sections
    • Processing rules
    • Preview processing rule
    • Fleets
      • Status
      • Config
      • Files
      • Agent errors
    • Fleet files
    • Search
    • Aws customer redirect
    • Cluster object regexes
    • Processing rule templates
    • Validate fluentbit config
    • Saml mappings
    • Core instances
      • Files
      • Secrets
      • Pipelines
      • Ingest checks
      • Checks
      • Cluster objects
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
    • Pipelines
      • Logs
      • Checks
      • Cluster objects
      • Metadata
      • Trace sessions
      • Trace session
        • Records
      • Config section set
      • Processing rules
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
      • Cluster object regexes
    • Agent errors
      • Dismiss
  • Specification
Powered by GitBook
On this page
  1. API reference

Processing rule templates

PreviousCluster object regexesNextValidate fluentbit config

Processing rule template

get
Authorizations
Path parameters
templateIDstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/processing_rule_templates/{templateID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Processing Rule Template",
  "pipelineVersion": "v24.5.0",
  "definition": {},
  "createdAt": "2025-05-14T22:38:24.111Z",
  "updatedAt": "2025-05-14T22:38:24.111Z"
}

Delete processing rule template

delete
Authorizations
Path parameters
templateIDstring · uuidRequired
Responses
200
Deleted
application/json
delete
DELETE /v2/processing_rule_templates/{templateID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Deleted

{
  "deleted": true,
  "deletedAt": "2025-05-14T22:38:24.111Z"
}
  • DELETEDelete processing rule template
  • PATCHUpdate processing rule template
  • GETProcessing rule template
  • DELETEDelete processing rule template
  • PATCHUpdate processing rule template
Deprecated

Delete processing rule template

delete

Delete a single processing rule template by its ID.

Authorizations
Path parameters
templateIDstring · uuidRequired
Responses
200
Deleted
application/json
delete
DELETE /v1/processing_rule_templates/{templateID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Deleted

{
  "deleted": true,
  "deletedAt": "2025-05-14T22:38:24.111Z"
}
Deprecated

Update processing rule template

patch

Update a processing rule template details.

Authorizations
Path parameters
templateIDstring · uuidRequired
Body
namestring | nullableOptionalDefault: nullExample: My template
pipelineVersionstring | nullableOptional

semver version of core-fluent-bit is running

Default: nullExample: v1.3.5
inputstring | nullableOptional

input to use as an example for the processing rule template

Default: nullExample: {"log":"line 2"}
isRawInputbooleanOptional

define if the input parameter is in raw or json format (false)

Default: false
Responses
200
Updated.
application/json
patch
PATCH /v1/processing_rule_templates/{templateID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
200

Updated.

{
  "updatedAt": "2025-05-14T22:38:24.111Z"
}

Update processing rule template

patch
Authorizations
Path parameters
templateIDstring · uuidRequired
Body
namestring | nullableOptionalDefault: nullExample: My Processing Rule Template
pipelineVersionstring | nullableOptionalDefault: nullExample: v24.5.0
Responses
200
Updated.
application/json
patch
PATCH /v2/processing_rule_templates/{templateID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "name": "My Processing Rule Template",
  "pipelineVersion": "v24.5.0",
  "definition": {}
}
200

Updated.

{
  "updatedAt": "2025-05-14T22:38:24.111Z"
}