Pipeline files

Pipeline file

get

File by ID.

Authorizations

userproject

Path parameters

fileIDstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/pipeline_files/{fileID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "myfile",
  "contents": "Ynl0ZXM=",
  "encrypted": true,
  "createdAt": "2025-05-09T06:29:16.099Z",
  "updatedAt": "2025-05-09T06:29:16.099Z"
}

Delete pipeline file

delete

Delete pipeline file by its ID. The file cannot be deleted if some pipeline config is still referencing it; you must delete the pipeline first if you want to delete the file.

Authorizations

userproject

Path parameters

fileIDstring · uuidRequired

Responses

204

No Content

delete

HTTPcURLJavaScriptPython

DELETE /v1/pipeline_files/{fileID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update pipeline file

patch

Update file by its ID.

Authorizations

userproject

Path parameters

fileIDstring · uuidRequired

Body

Update pipeline file request body.

namestring | nullableOptionalDefault: nullExample: newfile

contentsstring · byte | nullableOptionalDefault: null

encryptedboolean | nullableOptionalDefault: null

Responses

204

No Content

patch

HTTPcURLJavaScriptPython

PATCH /v1/pipeline_files/{fileID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "newfile",
  "contents": "Ynl0ZXM=",
  "encrypted": true
}

204

No Content

No content