Processing rule templates

Processing rule templates

Deprecated

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

get

/v1/projects/{projectID}/processing_rule_templates

Authorizations

userproject

Path parameters

projectIDstring · uuidrequired

Query parameters

lastinteger

Last processing rule templates.

beforestring

Processing rule templates before the given cursor.

namestring · min: 1 · max: 30

Filter processing rule templates by name.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}/processing_rule_templates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My template",
      "definition": {
        "name": "lua",
        "match": "*",
        "code": "function filter(tag, timestamp, record)\n  return 1, timestamp, record\nend",
        "call": "filter"
      },
      "pipelineVersion": "v1.3.5",
      "input": {
        "log": "line 2"
      },
      "isRawInput": true,
      "createdAt": "2025-03-12T04:28:07.191Z",
      "updatedAt": "2025-03-12T04:28:07.191Z"
    }
  ],
  "endCursor": null,
  "count": 1,
  "static": [
    {
      "name": "By Calyptia",
      "definition": {
        "name": "lua",
        "match": "*",
        "code": "function filter(tag, timestamp, record)\n  return 1, timestamp, record\nend",
        "call": "filter"
      }
    }
  ]
}

OK

Create processing rule template

Deprecated

Create a new processing rule template.

post

/v1/projects/{projectID}/processing_rule_templates

Authorizations

userproject

Path parameters

projectIDstring · uuidrequired

Body

namestring · min: 1 · max: 30required

Example: My template

definitionobjectrequiredDeprecated

pipelineVersionstring

semver version of core-fluent-bit is running

Example: v1.3.5

inputstring · min: 1 · max: 1048576

input to use as an example for the processing rule template

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

isRawInputboolean · default: false

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}/processing_rule_templates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My template",
    "definition": {
      "name": "lua",
      "match": "*",
      "code": "function filter(tag, timestamp, record)\n  return 1, timestamp, record\nend",
      "call": "filter"
    },
    "pipelineVersion": "v1.3.5",
    "input": {
      "log": "line 2"
    },
    "isRawInput": false
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-03-12T04:28:07.191Z"
}

Created

Processing rule templates

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

get

/v2/projects/{projectID}/processing_rule_templates

Authorizations

userproject

Path parameters

projectIDstring · uuidrequired

Query parameters

namestring · min: 1 · max: 30

Filter processing rule templates by name.

lastinteger

Last processing rule templates.

beforestring

Processing rule templates before the given cursor.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v2/projects/{projectID}/processing_rule_templates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "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-03-12T04:28:07.191Z",
      "updatedAt": "2025-03-12T04:28:07.191Z"
    }
  ],
  "endCursor": null,
  "count": 1
}

OK

Create processing rule template

post

/v2/projects/{projectID}/processing_rule_templates

Authorizations

userproject

Path parameters

projectIDstring · uuidrequired

Body

namestringrequired

Example: My Processing Rule Template

pipelineVersionstring | nullablerequired

Example: v24.5.0

definitionobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v2/projects/{projectID}/processing_rule_templates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My Processing Rule Template",
    "pipelineVersion": "v24.5.0",
    "definition": {}
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-03-12T04:28:07.191Z"
}

Created