Skip to content

API: Agents

This section explains how to work with agents via the API.

Get Agents

List all connected agents

1
2
GET /api/v1/agents HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

List only active agents

1
2
GET /api/v1/agents/active HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

List only inactive agents

1
2
GET /api/v1/agents/inactive HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Agent Details

Get details for a specific agent

1
2
GET /api/v1/agents/{AGENT_GUID} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Mark an agent as inactive

1
2
PUT /api/v1/agents/{AGENT_GUID}/inactive HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Update Agent Metadata

You can add or update metadata and custom properties for an agent.

Update metadata

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
PUT /api/v1/agents/{AGENT_GUID}/metadata HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "username": "exampleUser",
  "proc": "exampleProcess",
  "pid": 2222,
  "workingDir": "exampleDir",
  "os": 2,
  "os_major": 2,
  "os_minor": 2,
  "ips": "exampleIP",
  "hostname": "exampleHost",
  "customProperties": {
    "key": "value"
  }
}

Replace example values with your data.