Pipeline logs

Pipeline log

Pipeline log by ID.

GEThttps://cloud-api.calyptia.com/v1/pipeline_logs/{pipelineLogID}

Authorization

userproject

Path parameters

pipelineLogID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

pipelineID*string (uuid)

logs*string

lines*integer

status*PipelineLogStatus (enum)

The status of a pipeline log, if NEW hasn't been updated from the cluster. If DONE, logs have been retrieved from the cluster.

NEWDONE

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "logs": "text",
  "status": "NEW",
  "createdAt": "2024-11-21T09:59:20.147Z",
  "updatedAt": "2024-11-21T09:59:20.147Z"
}

Delete Pipeline Log

Delete a log given its ID.

DELETEhttps://cloud-api.calyptia.com/v1/pipeline_logs/{pipelineLogID}

Authorization

userproject

Path parameters

pipelineLogID*string (uuid)

Response

200

OK

Body

application/json

deleted*boolean

deletedAt*nullable string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "deleted": false,
  "deletedAt": "2024-11-21T09:59:20.147Z"
}

Update Pipeline Log

Update a log given its ID. The log will be updated with the given logs blob of text.

PATCHhttps://cloud-api.calyptia.com/v1/pipeline_logs/{pipelineLogID}

Authorization

userproject

Path parameters

pipelineLogID*string (uuid)

Body

application/json

logsnullable string

linesnullable integer

statusnullable enum

NEWDONE

Response

200

OK

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "updatedAt": "2024-11-21T09:59:20.147Z"
}