Processing rule templates

Delete processing rule template

Delete a single processing rule template by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/processing_rule_templates/{templateID}

Authorization

userproject

Path parameters

templateID*string (uuid)

Response

200

Deleted

Body

application/json

deleted*boolean

deletedAt*nullable string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "deleted": false,
  "deletedAt": "2024-12-03T16:40:15.874Z"
}

Update processing rule template

Update a processing rule template details.

PATCHhttps://cloud-api.calyptia.com/v1/processing_rule_templates/{templateID}

Authorization

userproject

Path parameters

templateID*string (uuid)

Body

application/json

namenullable string

Example: "My template"

pipelineVersionnullable string

semver version of core-fluent-bit is running

Example: "v1.3.5"

inputnullable string

input to use as an example for the processing rule template

isRawInputboolean

define if the input parameter is in raw or json format (false)

Response

200

Updated.

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "updatedAt": "2024-12-03T16:40:15.874Z"
}

Processing rule template

GEThttps://cloud-api.calyptia.com/v2/processing_rule_templates/{templateID}

Authorization

userproject

Path parameters

templateID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

projectID*string (uuid)

name*string

Example: "My Processing Rule Template"

pipelineVersion*nullable string

Example: "v24.5.0"

definition*object

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Processing Rule Template",
  "pipelineVersion": "v24.5.0",
  "definition": {},
  "createdAt": "2024-12-03T16:40:15.874Z",
  "updatedAt": "2024-12-03T16:40:15.874Z"
}

Delete processing rule template

DELETEhttps://cloud-api.calyptia.com/v2/processing_rule_templates/{templateID}

Authorization

userproject

Path parameters

templateID*string (uuid)

Response

200

Deleted

Body

application/json

deleted*boolean

deletedAt*nullable string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "deleted": false,
  "deletedAt": "2024-12-03T16:40:15.874Z"
}

Update processing rule template

PATCHhttps://cloud-api.calyptia.com/v2/processing_rule_templates/{templateID}

Authorization

userproject

Path parameters

templateID*string (uuid)

Body

application/json

namenullable string

Example: "My Processing Rule Template"

pipelineVersionnullable string

Example: "v24.5.0"

definitionnullable object

Response

200

Updated.

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "updatedAt": "2024-12-03T16:40:15.874Z"
}