Processing rule templates

Delete processing rule template

Deprecated

Delete a single processing rule template by its ID.

delete

/v1/processing_rule_templates/{templateID}

Authorizations

userproject

Path parameters

templateIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "deleted": true,
  "deletedAt": null
}

Deleted

Update processing rule template

Deprecated

Update a processing rule template details.

patch

/v1/processing_rule_templates/{templateID}

Authorizations

userproject

Path parameters

templateIDstring · uuidrequired

Body

namestring | nullable

Example: My template

definitionobject | nullableDeprecated

pipelineVersionstring | nullable

semver version of core-fluent-bit is running

Example: v1.3.5

inputstring | nullable

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 PATCH \
  --url 'https://cloud-api.calyptia.com/v1/processing_rule_templates/{templateID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My template",
    "definition": null,
    "pipelineVersion": "v1.3.5",
    "input": {
      "log": "line 2"
    },
    "isRawInput": false
  }'

200

200

{
  "updatedAt": "2025-03-12T04:23:57.805Z"
}

Updated.

Processing rule template

get

/v2/processing_rule_templates/{templateID}

Authorizations

userproject

Path parameters

templateIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "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:23:57.805Z",
  "updatedAt": "2025-03-12T04:23:57.805Z"
}

OK

Delete processing rule template

delete

/v2/processing_rule_templates/{templateID}

Authorizations

userproject

Path parameters

templateIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "deleted": true,
  "deletedAt": null
}

Deleted

Update processing rule template

patch

/v2/processing_rule_templates/{templateID}

Authorizations

userproject

Path parameters

templateIDstring · uuidrequired

Body

namestring | nullable

Example: My Processing Rule Template

pipelineVersionstring | nullable

Example: v24.5.0

definitionobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "updatedAt": "2025-03-12T04:23:57.805Z"
}

Updated.