Fleets
Retrieve a single fleet by ID.
Authorizations
Path parameters
fleetIDstring · uuidRequired
Query parameters
config_formatstring · enumOptionalPossible values:
Desired output config format.
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-06-30T20:53:12.240Z",
"updatedAt": "2025-06-30T20:53:12.240Z"
}
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-06-30T20:53:12.240Z"
}
Update a fleet details.
Authorizations
Path parameters
fleetIDstring · uuidRequired
Body
namestring | nullableOptionalDefault:
null
Example: updated-fleet
rawConfigstring | nullableOptionalDefault:
The fleet fluent-bit configuration in the format defined by configFormat.
null
configFormatstring · enum | nullableOptionalDefault:
null
Possible values: tagsstring[] | nullableOptionalDefault:
null
Example: 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-06-30T20:53:12.240Z"
}