Skip to content

API: Agents

List of connected agents

Request

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

List of active agents

Request

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

List of inactive agents

Request

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

Get single agent with provided GUID

Request

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

Mark agent as inactive

Request

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

Add missing values to agent metadata and/or custom value

Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
PUT /api/v1/agents/{AGENT_GUID}/metadata HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  {ONE_OR_MORE_METADATA_VALUES}
  "customProperties": {
    {ONE_OR_MORE_CUSTOM_VALUES}
  }
}

Example

 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": "qweqweqwe",
  "proc": "qweqweqwe",
  "pid": 2222,
  "workingDir": "qweqewqwe",
  "os": 2,
  "os_major": 2,
  "os_minor": 2,
  "ips": "qweqweqweqwe",
  "hostname": "qweqweqweqew",
  "customProperties": {
    "hola3": "asd"
  }
}