Logs

Pipeline Logs

Logs from a pipeline with backward pagination.

GEThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/logs

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Parent pipeline ID.

Query parameters

Response

200

OK

Body

application/json

items*array of PipelineLog (object)

endCursor*nullable string

count*integer (int32)

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
      "logs": "text",
      "status": "NEW",
      "createdAt": "2024-10-06T10:59:32.734Z",
      "updatedAt": "2024-10-06T10:59:32.734Z"
    }
  ],
  "endCursor": "text"
}

Create Pipeline Log

Create a new log within a pipeline. The log will be created with the given logs blob of text.

POSThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/logs

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Parent pipeline ID.

Body

application/json

logs*string

linesinteger

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/pipelines/{pipelineID}/logs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "logs": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-10-06T10:59:32.734Z"
}