Fleets

PreviousConfig sections NextStatus

Fleets.

List all the fleets within a project.

get

/v1/projects/{projectID}/fleets

Authorizations

Path parameters

projectIDstring · uuidrequired

Query parameters

namestring · max: 32

tags_querystring

"AND" separated query

Example: dev AND prod

lastinteger

beforestring

config_formatstring · enum

Desired output config format.

Options: ini, json, yaml

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}/fleets' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

[
  {
    "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-03-12T04:27:56.894Z",
    "updatedAt": "2025-03-12T04:27:56.894Z"
  }
]

Create fleet.

Create a fleet on the given project. Agents can be added later to this fleet and all of them will share the same config.

post

/v1/projects/{projectID}/fleets

Authorizations

Path parameters

projectIDstring · uuidrequired

Body

namestring · max: 32required

Example: my-fleet

minFluentBitVersionstringrequired

semver

Example: v1.0.0

rawConfigstringrequired

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

configFormatstring · enum | nullable

Options: ini, json, yaml

tagsstring[]required

Example: dev

skipConfigValidationboolean · default: falserequired