Ingest checks

Ingest Check

Check by ID.

GEThttps://cloud-api.calyptia.com/v1/ingest_checks/{checkID}

Authorization

userproject

Path parameters

checkID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

config*string (fluent-bit configuration)

status*CheckStatus (enum)

The status of a check.

newfailedrunningok

collectLogsboolean

logsstring (byte)

retries*number

number of retries for the check before marking it as failed

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "config": "text",
  "status": "new",
  "collectLogs": false,
  "logs": "Ynl0ZXM=",
  "retries": 0,
  "createdAt": "2024-11-21T09:29:29.546Z",
  "updatedAt": "2024-11-21T09:29:29.546Z"
}

Delete a Ingest check.

Delete Ingest check by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/ingest_checks/{checkID}

Authorization

userproject

Path parameters

checkID*string (uuid)

Response

204

No Content

Request

JavaScriptCurlPython

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

Update Ingest check

Update a Ingest check by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/ingest_checks/{checkID}

Authorization

userproject

Path parameters

checkID*string (uuid)

Body

application/json

logsnullable string

logs coming from the fluent-bit pod, maximum size is 10MiB.

statusCheckStatus (enum)

The status of a check.

newfailedrunningok

Response

204

No Content

Request

JavaScriptCurlPython

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