Files

Pipeline files

Files from a pipeline.

GEThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/files

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

200

OK

Body

application/json

id*string (uuid)

processingRuleID*nullable string (uuid)

name*string

Example: "myfile"

contents*string (byte)

encrypted*boolean

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
    "name": "myfile",
    "contents": "Ynl0ZXM=",
    "encrypted": false,
    "createdAt": "2024-12-22T05:02:46.886Z",
    "updatedAt": "2024-12-22T05:02:46.886Z"
  }
]

Create pipeline file

Create file within a pipeline. The given name is unique within the pipeline. These files can be referenced by their name within a fluentbit configuration file like so {{files.thename}}. Use them to share common stuff like parsers.

POSThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/files

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

name*string

Example: "newfile"

contents*string (byte)

encrypted*boolean

Response

201

Created

Body

application/json

id*string (uuid)

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/files', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "newfile",
      "contents": "Ynl0ZXM=",
      "encrypted": false
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-12-22T05:02:46.886Z"
}