Fleets

Fleet.

get

Retrieve a single fleet by ID.

Authorizations

userproject

Path parameters

fleetIDstring · uuidRequired

Query parameters

config_formatstring · enumOptional

Desired output config format.

Available options:

Responses

application/json

objectOptional

Group of agents sharing the same config.

get

HTTPcURLJavaScriptPython

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": "ini",
  "tags": [
    "dev"
  ],
  "agentsCount": {
    "active": 1,
    "inactive": 1,
    "withErrors": 1
  },
  "createdAt": "2025-04-20T12:09:13.786Z",
  "updatedAt": "2025-04-20T12:09:13.786Z"
}

Delete fleet.

delete

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

Authorizations

userproject

Path parameters

fleetIDstring · uuidRequired

Responses

application/json

objectOptional

delete

HTTPcURLJavaScriptPython

DELETE /v1/fleets/{fleetID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Deleted.

{
  "deleted": true,
  "deletedAt": "2025-04-20T12:09:13.786Z"
}

Update fleet.

patch

Update a fleet details.

Authorizations

userproject

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: nullAvailable options:

tagsstring[] | nullableOptionalDefault: nullExample: updated

skipConfigValidationbooleanRequiredDefault: false

Responses

application/json

objectOptional

patch

HTTPcURLJavaScriptPython

PATCH /v1/fleets/{fleetID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "updated-fleet",
  "rawConfig": "text",
  "configFormat": "ini",
  "tags": [
    "updated"
  ],
  "skipConfigValidation": true
}

200

Updated.

{
  "updatedAt": "2025-04-20T12:09:13.786Z"
}