Ingest checks

Ingest checks

Ingest checks associated to a core instance.

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

Authorization

userproject

Path parameters

coreInstanceID*string (uuid)

Query parameters

Response

200

OK

Headers

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

JavaScriptCurl

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

Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": "text",
    "status": "new",
    "collectLogs": false,
    "logs": "Ynl0ZXM=",
    "retries": 0,
    "createdAt": "2024-07-27T03:56:53.451Z",
    "updatedAt": "2024-07-27T03:56:53.451Z"
  }
]

Create Ingest check

Create an Ingest check within a core instance.

POSThttps://cloud-api.calyptia.com/v1/core_instances/{coreInstanceID}/ingest_checks

Authorization

userproject

Path parameters

coreInstanceID*string (uuid)

Body

application/json

status*CheckStatus (enum)

The status of a check.

newfailedrunningok

retries*number

number of retries for the check before marking it as failed

configSectionID*string (uuid)

config section UUID to be used on this Ingest check. Note that the ingest check config section's kind has to be of either type input or output.

collectLogsboolean

Determine if the logs for the fluent-bit pod should be forwarded to Calyptia.

Response

201

Created

Body

application/json

id*string (uuid)

createdAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/core_instances/{coreInstanceID}/ingest_checks', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "new",
      "retries": 3,
      "configSectionID": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-07-27T03:56:53.451Z"
}