LogoLogo
Support PortalCalyptia CoreContact Us
Calyptia Core API
Calyptia Core API
  • Specification
  • About
  • API reference
    • Verification email
    • Projects
      • Tokens
      • Members
      • Invite
      • Agents
      • Aggregators
      • Core instances
      • Aggregator pipelines
      • Pipelines
      • Environments
      • Metrics
      • Config sections
      • Fleets
        • Status
      • Aws contracts
      • Processing rule templates
      • Saml mappings
    • Project tokens
    • Members
    • Join project
    • Agents
      • Config history
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
      • Errors
    • Aggregators
      • Ping
      • Resource profiles
      • Pipelines
      • Pipelines metrics
    • Core instance files
    • Core instance secrets
    • Resource profiles
    • Aggregator pipelines
      • Config history
      • Status history
      • Files
      • Secrets
      • Ports
    • Pipeline files
    • Pipeline logs
    • Pipeline checks
    • Core instance checks
    • Ingest checks
    • Pipeline secrets
    • Pipeline ports
    • Config validate
    • Config validate v2
    • Environments
    • Pipeline metrics
    • Aggregator metrics
    • Cluster objects
    • Trace sessions
      • Records
    • Config sections
    • Processing rules
    • Preview processing rule
    • Fleets
      • Status
      • Config
      • Files
      • Agent errors
    • Fleet files
    • Search
    • Aws customer redirect
    • Cluster object regexes
    • Processing rule templates
    • Validate fluentbit config
    • Saml mappings
    • Core instances
      • Files
      • Secrets
      • Pipelines
      • Ingest checks
      • Checks
      • Cluster objects
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
    • Pipelines
      • Logs
      • Checks
      • Cluster objects
      • Metadata
      • Trace sessions
      • Trace session
        • Records
      • Config section set
      • Processing rules
      • Metrics
      • Metrics by plugin
      • Metrics over time
      • Metrics over time by plugin
      • Cluster object regexes
    • Agent errors
      • Dismiss
  • Specification
Powered by GitBook
On this page
  1. API reference
  2. Core instances

Ingest checks

PreviousPipelinesNextChecks
  • GETIngest checks
  • POSTCreate Ingest check

Ingest checks

get

Ingest checks associated to a core instance.

Authorizations
Path parameters
coreInstanceIDstring · uuidRequired
Query parameters
lastintegerOptional

Last Ingest checks.

beforestringOptional

End cursor.

Responses
200
OK
application/json
get
GET /v1/core_instances/{coreInstanceID}/ingest_checks HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": "text",
    "status": "new",
    "collectLogs": true,
    "logs": "Ynl0ZXM=",
    "retries": 1,
    "createdAt": "2025-05-11T19:22:35.939Z",
    "updatedAt": "2025-05-11T19:22:35.939Z"
  }
]

Create Ingest check

post

Create an Ingest check within a core instance.

Authorizations
Path parameters
coreInstanceIDstring · uuidRequired
Body

Create core instance Ingest check request body.

statusstring · enumRequired

The status of a check.

Default: newPossible values:
retriesnumberRequired

number of retries for the check before marking it as failed

Default: 3
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.

collectLogsbooleanOptional

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

Default: false
Responses
201
Created
application/json
post
POST /v1/core_instances/{coreInstanceID}/ingest_checks HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "status": "new",
  "retries": 1,
  "configSectionID": "123e4567-e89b-12d3-a456-426614174000",
  "collectLogs": true
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-11T19:22:35.939Z"
}