Ingest checks

PreviousPipelines NextChecks

Ingest checks

Ingest checks associated to a core instance.

get

/v1/core_instances/{coreInstanceID}/ingest_checks

Authorizations

Path parameters

coreInstanceIDstring · uuidrequired

Query parameters

lastinteger

Last Ingest checks.

beforestring

End cursor.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/core_instances/{coreInstanceID}/ingest_checks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": "text",
    "status": "new",
    "collectLogs": false,
    "logs": "text",
    "retries": 0,
    "createdAt": "2025-03-12T03:44:01.586Z",
    "updatedAt": "2025-03-12T03:44:01.586Z"
  }
]

Create Ingest check

Create an Ingest check within a core instance.

post

/v1/core_instances/{coreInstanceID}/ingest_checks

Authorizations

Path parameters

coreInstanceIDstring · uuidrequired

Body

statusstring · enum · default: newrequired

The status of a check.

Options: new, failed, running, ok

retriesnumber · default: 3required

number of retries for the check before marking it as failed

configSectionIDstring · uuidrequired

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 · default: false

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