Fleets

Fleet.

Retrieve a single fleet by ID.

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

Authorization

userproject

Path parameters

fleetID*string (uuid)

Query parameters

Response

200

OK

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/fleets/{fleetID}', {
    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": {
    "active": 0,
    "inactive": 0,
    "withErrors": 0
  },
  "createdAt": "2024-10-29T14:31:08.931Z",
  "updatedAt": "2024-10-29T14:31:08.931Z"
}

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

userproject

Path parameters

fleetID*string (uuid)

Response

200

Deleted.

Body

application/json

deleted*boolean

deletedAt*nullable string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "deleted": false,
  "deletedAt": "2024-10-29T14:31:08.931Z"
}

Update fleet.

Update a fleet details.

PATCHhttps://cloud-api.calyptia.com/v1/fleets/{fleetID}

Authorization

userproject

Path parameters

fleetID*string (uuid)

Body

application/json

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

200

Updated.

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/fleets/{fleetID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "skipConfigValidation": false
    }),
});
const data = await response.json();

Response

200

{
  "updatedAt": "2024-10-29T14:31:08.931Z"
}