Fleets

Fleets.

List all the fleets within a project.

GEThttps://cloud-api.calyptia.com/v1/projects/{projectID}/fleets

Authorization

userproject

Path parameters

projectID*string (uuid)

Query parameters

Response

200

OK

Headers

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects/{projectID}/fleets', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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": {},
    "createdAt": "2024-10-16T08:47:35.183Z",
    "updatedAt": "2024-10-16T08:47:35.183Z"
  }
]

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.

POSThttps://cloud-api.calyptia.com/v1/projects/{projectID}/fleets

Authorization

userproject

Path parameters

projectID*string (uuid)

Body

application/json

name*string

Example: "my-fleet"

minFluentBitVersion*string

semver

Example: "v1.0.0"

rawConfig*string

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

configFormatnullable enum

inijsonyaml

tags*array of string

skipConfigValidation*boolean

Response

201

Created

Body

application/json

id*string (uuid)

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects/{projectID}/fleets', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "my-fleet",
      "minFluentBitVersion": "v1.0.0",
      "rawConfig": "text",
      "tags": [
        "dev"
      ],
      "skipConfigValidation": false
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-10-16T08:47:35.183Z"
}