Processing rules

Processing rule

GEThttps://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}

Authorization

userproject

Path parameters

processingRuleID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

pipelineID*string (uuid)

configSectionID*string (uuid)

fileID*string (uuid)

match*string

Example: "*"

isMatchRegexp*boolean

actions*array of RuleActionV1 (object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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,
  "actions": [
    {
      "description": "Sample action",
      "enabled": true,
      "selectors": [
        {
          "expr": "some_key"
        }
      ],
      "add": {
        "key": "some_key",
        "value": "some_value"
      },
      "renameTo": "renamed",
      "copyAs": "copied",
      "maskWith": "masked"
    }
  ],
  "createdAt": "2024-11-21T10:12:02.784Z",
  "updatedAt": "2024-11-21T10:12:02.784Z"
}

Delete processing rule

DELETEhttps://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}

Authorization

userproject

Path parameters

processingRuleID*string (uuid)

Response

204

Deleted

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update processing rule

PATCHhttps://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}

Authorization

userproject

Path parameters

processingRuleID*string (uuid)

Body

application/json

matchnullable string

Example: "*"

isMatchRegexpnullable boolean

actionsnullable array of RuleActionV1 (object)

Response

200

Updated

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/processing_rules/{processingRuleID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "updatedAt": "2024-11-21T10:12:02.784Z"
}