Fleets
Fleet.
Retrieve a single fleet by ID.
GEThttps://cloud-api.calyptia.com/v1/fleets/{fleetID}
Authorization
Path parameters
fleetID*string (uuid)
Query parameters
Response
OK
Body
id*string (uuid)
projectID*string (uuid)
name*string
Example: "my-fleet"
minFluentBitVersion*string
Example: "v1.0.0"
rawConfig*string
The fleet fluent-bit configuration in the format defined by configFormat.
configFormat*enum
inijsonyaml
tags*array of string
agentsCount*FleetAgentsCount (object)
Both active and inactive can sum up to the total count
of agents that the fleet has.
withErrors
is the count of particular agents that have
some errors that have not been dismissed yet.
createdAt*string (date-time)
updatedAt*string (date-time)
Request
Response
Delete fleet.
Delete a single fleet by its ID. All associated agents will remain but the shared config wil be detached.
DELETEhttps://cloud-api.calyptia.com/v1/fleets/{fleetID}
Authorization
Path parameters
fleetID*string (uuid)
Response
Deleted.
Body
deleted*boolean
deletedAt*nullable string (date-time)
Request
Response
Update fleet.
Update a fleet details.
PATCHhttps://cloud-api.calyptia.com/v1/fleets/{fleetID}
Authorization
Path parameters
fleetID*string (uuid)
Body
namenullable string
Example: "updated-fleet"
rawConfignullable string
The fleet fluent-bit configuration in the format defined by configFormat.
configFormatnullable enum
inijsonyaml
tagsnullable array of string
skipConfigValidation*boolean
Response
Updated.
Body
updatedAt*string (date-time)
Request
Response