Pipeline files

Pipeline file

File by ID.

GEThttps://cloud-api.calyptia.com/v1/pipeline_files/{fileID}

Authorization

userproject

Path parameters

fileID*string (uuid)

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/pipeline_files/{fileID}', {
    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-09-08T02:33:16.936Z",
  "updatedAt": "2024-09-08T02:33:16.936Z"
}

Delete pipeline file

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.

DELETEhttps://cloud-api.calyptia.com/v1/pipeline_files/{fileID}

Authorization

userproject

Path parameters

fileID*string (uuid)

Response

204

No Content

Request

JavaScriptCurlPython

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

Update pipeline file

Update file by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/pipeline_files/{fileID}

Authorization

userproject

Path parameters

fileID*string (uuid)

Body

application/json

namenullable string

Example: "newfile"

contentsnullable string (byte)

encryptednullable boolean

Response

204

No Content

Request

JavaScriptCurlPython

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