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. Projects

Core instances

PreviousAggregatorsNextAggregator pipelines

Core Instances

get

Core Instances from a project with backward pagination.

Authorizations
Path parameters
projectIDstring ยท uuidRequired

Parent project ID.

Query parameters
lastintegerOptional

Limit to the last core instances.

beforestringOptional

Paginate core instances before the given cursor.

namestringOptional

Filter core instances with the given name.

environment_idstringOptional

Filter core instances with the given environment ID.

tags_querystringOptional

Filter core instances with the given tags query.

Example: tagone AND tagtwo
exclude_internalbooleanOptional

Exclude internal pipelines (health-check) from count.

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

OK

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "my-core-instance",
      "version": "v0.1.12",
      "status": "running",
      "metadata": {
        "aws.ami_id": "text",
        "aws.account_id": "text",
        "aws.hostname": "text",
        "aws.vpc_id": "text",
        "aws.private_ipv4": "text",
        "aws.public_ipv4": "text",
        "aws.ec2_instance_id": "text",
        "aws.ec2_instance_type": "text",
        "aws.az": "text"
      },
      "pipelinesCount": 1,
      "createdAt": "2025-05-15T00:06:12.797Z",
      "updatedAt": "2025-05-15T00:06:12.797Z",
      "tags": [
        "text"
      ],
      "environmentName": "default",
      "skipServiceCreation": false
    }
  ],
  "endCursor": "text",
  "count": 1
}