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

Fleets

PreviousPreview processing ruleNextStatus

Fleet.

get

Retrieve a single fleet by ID.

Authorizations
Path parameters
fleetIDstring · uuidRequired
Query parameters
config_formatstring · enumOptional

Desired output config format.

Possible values:
Responses
200
OK
application/json
get
GET /v1/fleets/{fleetID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-fleet",
  "minFluentBitVersion": "v1.0.0",
  "rawConfig": "text",
  "configFormat": "classic",
  "tags": [
    "dev"
  ],
  "agentsCount": {
    "active": 1,
    "inactive": 1,
    "withErrors": 1
  },
  "createdAt": "2025-05-27T18:20:31.728Z",
  "updatedAt": "2025-05-27T18:20:31.728Z"
}

Delete fleet.

delete

Delete a single fleet by its ID. All associated agents will remain but the shared config wil be detached.

Authorizations
Path parameters
fleetIDstring · uuidRequired
Responses
200
Deleted.
application/json
delete
DELETE /v1/fleets/{fleetID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Deleted.

{
  "deleted": true,
  "deletedAt": "2025-05-27T18:20:31.728Z"
}
  • GETFleet.
  • DELETEDelete fleet.
  • PATCHUpdate fleet.

Update fleet.

patch

Update a fleet details.

Authorizations
Path parameters
fleetIDstring · uuidRequired
Body
namestring | nullableOptionalDefault: nullExample: updated-fleet
rawConfigstring | nullableOptional

The fleet fluent-bit configuration in the format defined by configFormat.

Default: null
configFormatstring · enum | nullableOptionalDefault: nullPossible values:
tagsstring[] | nullableOptionalDefault: nullExample: updated
skipConfigValidationbooleanRequiredDefault: false
Responses
200
Updated.
application/json
patch
PATCH /v1/fleets/{fleetID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "name": "updated-fleet",
  "rawConfig": "text",
  "configFormat": "classic",
  "tags": [
    "updated"
  ],
  "skipConfigValidation": false
}
200

Updated.

{
  "updatedAt": "2025-05-27T18:20:31.728Z"
}