Fleets

Fleet.

Retrieve a single fleet by ID.

get

/v1/fleets/{fleetID}

Authorizations

userproject

Path parameters

fleetIDstring · uuidrequired

Query parameters

config_formatstring · enum

Desired output config format.

Options: ini, json, yaml

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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:20:26.851Z",
  "updatedAt": "2025-03-12T04:20:26.851Z"
}

OK

Delete fleet.

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

delete

/v1/fleets/{fleetID}

Authorizations

userproject

Path parameters

fleetIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "deleted": true,
  "deletedAt": null
}

Deleted.

Update fleet.

Update a fleet details.

patch

/v1/fleets/{fleetID}

Authorizations

userproject

Path parameters

fleetIDstring · uuidrequired

Body

namestring | nullable

Example: updated-fleet

rawConfigstring | nullable

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

configFormatstring · enum | nullable

Options: ini, json, yaml

tagsstring[] | nullable

Example: updated

skipConfigValidationboolean · default: falserequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/fleets/{fleetID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "updated-fleet",
    "rawConfig": null,
    "configFormat": null,
    "tags": null,
    "skipConfigValidation": false
  }'

200

200

{
  "updatedAt": "2025-03-12T04:20:26.851Z"
}

Updated.