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

Pipeline checks

PreviousPipeline logsNextCore instance checks

Pipeline check

get

Check by ID.

Authorizations
Path parameters
checkIDstring · uuidRequired
Responses
200
OK
application/json
get
GET /v1/pipeline_checks/{checkID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "protocol": "tcp",
  "status": "new",
  "retries": 1,
  "port": 1,
  "host": "localhost",
  "createdAt": "2025-05-09T07:36:05.556Z",
  "updatedAt": "2025-05-09T07:36:05.556Z"
}

Delete pipeline check

delete

Delete pipeline check by its ID.

Authorizations
Path parameters
checkIDstring · uuidRequired
Responses
204
No Content
delete
DELETE /v1/pipeline_checks/{checkID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

  • GETPipeline check
  • DELETEDelete pipeline check
  • PATCHUpdate pipeline check

Update pipeline check

patch

Update check by its ID.

Authorizations
Path parameters
checkIDstring · uuidRequired
Body

Update pipeline check request body.

protocolstring · enum | nullableOptional

Valid protocol types defined for a pipelines.

Default: nullPossible values:
statusstring · enum | nullableOptional

The status of a check.

Default: nullPossible values:
retriesnumber | nullableOptional

number of retries for the check before marking it as unreachable.

Default: null
hoststring | nullableOptional

DNS label format as of defined on RFC1123 or an IPv4 address.

Default: nullExample: localhost
portnumber | nullableOptional

valid 0-65535 port number

Default: null
Responses
204
No Content
patch
PATCH /v1/pipeline_checks/{checkID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "protocol": "tcp",
  "status": "new",
  "retries": 1,
  "host": "localhost",
  "port": 1
}
204

No Content

No content