Processing rules

Processing rule

get

Deprecated

Authorizations

userproject

Path parameters

processingRuleIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "configSectionID": "123e4567-e89b-12d3-a456-426614174000",
  "fileID": "123e4567-e89b-12d3-a456-426614174000",
  "match": "*",
  "isMatchRegexp": true,
  "language": "lua",
  "actions": [
    {
      "kind": "add",
      "description": "Sample action",
      "enabled": true,
      "selectors": [
        {
          "kind": "key",
          "op": "equal",
          "expr": "some_key"
        }
      ],
      "add": {
        "key": "some_key",
        "value": "some_value"
      },
      "renameTo": "renamed",
      "copyAs": "copied",
      "maskWith": "masked"
    }
  ],
  "createdAt": "2025-03-21T18:13:46.708Z",
  "updatedAt": "2025-03-21T18:13:46.708Z"
}

OK

Delete processing rule

delete

Deprecated

Authorizations

userproject

Path parameters

processingRuleIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

Deleted

Update processing rule

patch

Deprecated

Authorizations

userproject

Path parameters

processingRuleIDstring · uuidrequired

Body

matchstring | nullableoptional

Example: *

isMatchRegexpboolean | nullableoptional

languagestring · enum | nullableoptionalDeprecated

Options: lua

actionsobject[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "match": "*",
    "isMatchRegexp": true,
    "language": "lua",
    "actions": [
      {
        "kind": "add",
        "description": "Sample action",
        "enabled": true,
        "selectors": [
          {
            "kind": "key",
            "op": "equal",
            "expr": "some_key"
          }
        ],
        "add": {
          "key": "some_key",
          "value": "some_value"
        },
        "renameTo": "renamed",
        "copyAs": "copied",
        "maskWith": "masked"
      }
    ]
  }'

application/json

200

200

{
  "updatedAt": "2025-03-21T18:13:46.708Z"
}

Updated