Agents

Register agent

Register agent within a project. The project in which the agent is registered is parsed from the authorization token. Users are not allowed to register agents.

post

/v1/agents

Authorizations

Body

fleetIDstring · uuid | nullable

namestring · hostnamerequired

Example: new-agent

machineIDstringrequired

typestring · enumrequired

Options: fluentbit, fluentd

versionstringrequired

Example: v1.8.6

editionstring · enumrequired

Options: community, enterprise

flagsstring[] | nullablerequired

rawConfigstringrequired

metadataobject | nullable

environmentIDstring | nullable

environment ID to associate this agent with.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/agents' \
  --header 'X-Project-Token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "fleetID": null,
    "name": "new-agent",
    "machineID": "text",
    "type": "fluentbit",
    "version": "v1.8.6",
    "edition": "community",
    "flags": null,
    "rawConfig": "text",
    "metadata": null,
    "environmentID": null
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "redacted",
  "name": "my-agent",
  "createdAt": "2025-03-12T03:44:42.137Z",
  "environmentName": "default"
}

Created

Agent

Agents by ID.

get

/v1/agents/{agentID}

Authorizations

userproject

Path parameters

agentIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fleetID": null,
  "token": "redacted",
  "name": "my-agent",
  "machineID": "text",
  "type": "fluentbit",
  "version": "v1.8.6",
  "edition": "community",
  "status": "healthy",
  "os": "unknown",
  "arch": "unknown",
  "flags": null,
  "tags": null,
  "rawConfig": "text",
  "metadata": null,
  "firstMetricsAddedAt": null,
  "lastMetricsAddedAt": null,
  "createdAt": "2025-03-12T03:44:42.137Z",
  "updatedAt": "2025-03-12T03:44:42.137Z",
  "environmentName": "default"
}

OK

Delete agent

Delete agent by its ID.

delete

/v1/agents/{agentID}

Authorizations

userproject

Path parameters

agentIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

No Content

Update agent

Update agent by its ID.

patch

/v1/agents/{agentID}

Authorizations

userproject

Path parameters

agentIDstring · uuidrequired

Body

fleetIDstring · uuid | nullable

namestring · hostname | nullable

Example: new-agent

versionstring | nullable

Example: v1.8.6

editionstring · enum | nullable

Options: community, enterprise

flagsstring[] | nullable

rawConfigstring | nullable

metadataobject | nullable

environmentIDstring | nullable

environment ID to associate this agent with.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/agents/{agentID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "fleetID": null,
    "name": "new-agent",
    "version": "v1.8.6",
    "edition": null,
    "flags": null,
    "rawConfig": null,
    "metadata": null,
    "environmentID": null
  }'

204

204

No body

No Content