Support PortalCalyptia CoreContact Us

Agents

Register agent

post

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.

Authorizations
Body

Register agent request body.

fleetIDstring · uuid | nullableOptionalDefault: null
namestring · hostnameRequiredExample: new-agent
machineIDstringRequired
typestring · enumRequiredPossible values:
versionstringRequiredExample: v1.8.6
editionstring · enumRequiredPossible values:
flagsstring[] | nullableRequiredDefault: null
rawConfigstringRequired
metadataobject | nullableOptionalDefault: null
environmentIDstring | nullableOptional

environment ID to associate this agent with.

Default: null
Responses
201
Created
application/json
post
POST /v1/agents HTTP/1.1
Host: cloud-api.calyptia.com
X-Project-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "fleetID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "new-agent",
  "machineID": "text",
  "type": "fluentbit",
  "version": "v1.8.6",
  "edition": "community",
  "flags": [
    "text"
  ],
  "rawConfig": "text",
  "metadata": {},
  "environmentID": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "redacted",
  "name": "my-agent",
  "createdAt": "2025-06-27T23:32:33.125Z",
  "environmentName": "default"
}

Agent

get

Agents by ID.

Authorizations
Path parameters
agentIDstring · uuidRequired
Responses
200
OK
application/json
get
GET /v1/agents/{agentID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fleetID": "123e4567-e89b-12d3-a456-426614174000",
  "token": "redacted",
  "name": "my-agent",
  "machineID": "text",
  "type": "fluentbit",
  "version": "v1.8.6",
  "edition": "community",
  "status": "healthy",
  "os": "unknown",
  "arch": "unknown",
  "flags": [
    "text"
  ],
  "tags": [
    "text"
  ],
  "rawConfig": "text",
  "metadata": {},
  "firstMetricsAddedAt": "2025-06-27T23:32:33.125Z",
  "lastMetricsAddedAt": "2025-06-27T23:32:33.125Z",
  "createdAt": "2025-06-27T23:32:33.125Z",
  "updatedAt": "2025-06-27T23:32:33.125Z",
  "environmentName": "default"
}

Delete agent

delete

Delete agent by its ID.

Authorizations
Path parameters
agentIDstring · uuidRequired
Responses
204
No Content
delete
DELETE /v1/agents/{agentID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

Update agent

patch

Update agent by its ID.

Authorizations
Path parameters
agentIDstring · uuidRequired
Body

Update agent request body.

fleetIDstring · uuid | nullableOptionalDefault: null
namestring · hostname | nullableOptionalDefault: nullExample: new-agent
versionstring | nullableOptionalDefault: nullExample: v1.8.6
editionstring · enum | nullableOptionalDefault: nullPossible values:
flagsstring[] | nullableOptionalDefault: null
rawConfigstring | nullableOptionalDefault: null
metadataobject | nullableOptionalDefault: null
environmentIDstring | nullableOptional

environment ID to associate this agent with.

Default: null
Responses
204
No Content
patch
PATCH /v1/agents/{agentID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "fleetID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "new-agent",
  "version": "v1.8.6",
  "edition": "community",
  "flags": [
    "text"
  ],
  "rawConfig": "text",
  "metadata": {},
  "environmentID": "text"
}
204

No Content

No content
PreviousJoin projectNextConfig history