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
  2. Projects

Processing rule templates

PreviousAws contractsNextSaml mappings

Processing rule templates

get

List all processing rule templates in descending order with backward pagination.

Authorizations
Path parameters
projectIDstring · uuidRequired
Query parameters
namestring · min: 1 · max: 30Optional

Filter processing rule templates by name.

lastintegerOptional

Last processing rule templates.

beforestringOptional

Processing rule templates before the given cursor.

Responses
200
OK
application/json
get
GET /v2/projects/{projectID}/processing_rule_templates HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My Processing Rule Template",
      "pipelineVersion": "v24.5.0",
      "definition": {},
      "createdAt": "2025-06-06T01:02:36.091Z",
      "updatedAt": "2025-06-06T01:02:36.091Z"
    }
  ],
  "endCursor": "123e4567-e89b-12d3-a456-426614174000",
  "count": 1
}
  • GETProcessing rule templates
  • POSTCreate processing rule template
  • GETProcessing rule templates
  • POSTCreate processing rule template
Deprecated

Processing rule templates

get

List all processing rule templates in descending order with backward pagination.

Authorizations
Path parameters
projectIDstring · uuidRequired
Query parameters
lastintegerOptional

Last processing rule templates.

beforestringOptional

Processing rule templates before the given cursor.

namestring · min: 1 · max: 30Optional

Filter processing rule templates by name.

Responses
200
OK
application/json
get
GET /v1/projects/{projectID}/processing_rule_templates HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

No content

Deprecated

Create processing rule template

post

Create a new processing rule template.

Authorizations
Path parameters
projectIDstring · uuidRequired
Body
namestring · min: 1 · max: 30RequiredExample: My template
pipelineVersionstringOptional

semver version of core-fluent-bit is running

Example: v1.3.5
inputstring · min: 1 · max: 1048576Optional

input to use as an example for the processing rule template

Example: {"log":"line 2"}
isRawInputbooleanOptional

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

Default: false
Responses
201
Created
application/json
post
POST /v1/projects/{projectID}/processing_rule_templates HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-06T01:02:36.091Z"
}

Create processing rule template

post
Authorizations
Path parameters
projectIDstring · uuidRequired
Body
namestringRequiredExample: My Processing Rule Template
pipelineVersionstring | nullableRequiredDefault: nullExample: v24.5.0
Responses
201
Created
application/json
post
POST /v2/projects/{projectID}/processing_rule_templates 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": {}
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-06T01:02:36.091Z"
}