Processing rules

Processing rules

Deprecated

get

/v1/pipelines/{pipelineID}/processing_rules

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Query parameters

lastinteger

Last processing rules.

beforestring

Processing rules before the given cursor.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/processing_rules' \
  --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:35:02.934Z",
    "updatedAt": "2025-03-12T04:35:02.934Z"
  }
]

OK

Create a processing rule

Deprecated

Create a processing rule in the given pipeline. Only one processing rule is allowed per pipeline.

post

/v1/pipelines/{pipelineID}/processing_rules

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Body

matchstringrequired

Example: *

isMatchRegexpboolean · default: falserequired

languagestring · enumrequiredDeprecated

Options: lua

actionsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/processing_rules' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
      }
    ]
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "configSectionID": "123e4567-e89b-12d3-a456-426614174000",
  "fileID": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "123e4567-e89b-12d3-a456-426614174000"
}

Created