Processing rules

Processing rule

Deprecated

get

/v1/processing_rules/{processingRuleID}

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": false,
  "language": "lua",
  "actions": [
    {
      "kind": "add",
      "description": "Sample action",
      "enabled": true,
      "selectors": [
        {
          "kind": "key",
          "op": "equal",
          "expr": "some_key"
        }
      ],
      "add": null,
      "renameTo": "renamed",
      "copyAs": "copied",
      "maskWith": "masked"
    }
  ],
  "createdAt": "2025-03-12T04:25:48.732Z",
  "updatedAt": "2025-03-12T04:25:48.732Z"
}

OK

Delete processing rule

Deprecated

delete

/v1/processing_rules/{processingRuleID}

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

Deprecated

patch

/v1/processing_rules/{processingRuleID}

Authorizations

userproject

Path parameters

processingRuleIDstring · uuidrequired

Body

matchstring | nullable

Example: *

isMatchRegexpboolean | nullable

languagestring · enum | nullableDeprecated

Options: lua

actionsobject[] | nullable

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": null,
    "language": null,
    "actions": null
  }'

200

200

{
  "updatedAt": "2025-03-12T04:25:48.732Z"
}

Updated