Back to Documentation

Agents API

Manage security agents and their configuration programmatically

List Agents

Retrieve all agents in your organization.

GET /v1/agents

Response:
{
  "agents": [
    {
      "id": "agent_123",
      "name": "Web Server Monitor",
      "status": "active",
      "type": "network",
      "last_seen": "2025-01-08T10:30:00Z"
    }
  ]
}

Get Agent Details

Retrieve detailed information about a specific agent.

GET /v1/agents/:id

Response:
{
  "id": "agent_123",
  "name": "Web Server Monitor",
  "status": "active",
  "type": "network",
  "config": {
    "scan_interval": 60,
    "alert_threshold": "high"
  },
  "metrics": {
    "threats_detected": 42,
    "uptime": 99.9
  }
}

Update Agent Configuration

Modify agent settings and policies.

PATCH /v1/agents/:id
Content-Type: application/json

{
  "config": {
    "scan_interval": 30,
    "alert_threshold": "medium"
  }
}

Delete Agent

DELETE /v1/agents/:id