For the complete documentation index, see llms.txt. This page is also available as Markdown.

Hosts

Read Host

get
Path parameters
uidintegerRequired
Responses
200

Successful Response

application/json
idintegerRequired
namestringRequired
internal_ipstringRequired
get/api/v2/hosts/{uid}
GET /api/v2/hosts/{uid} HTTP/1.1
Accept: */*
{
  "id": 1,
  "name": "text",
  "internal_ip": "text"
}

Read Hosts

get
Responses
200

Successful Response

application/json
get/api/v2/hosts
GET /api/v2/hosts HTTP/1.1
Accept: */*
{
  "records": [
    {
      "id": 1,
      "name": "text",
      "internal_ip": "text"
    }
  ]
}

Read Process

get
Path parameters
uidintegerRequired
host_idintegerRequired
Responses
200

Successful Response

application/json
process_idintegerRequired
process_namestringRequired
host_idintegerRequired
architecturestring · nullableOptional
userstring · nullableOptional
stalebooleanRequired
agent_idstring · nullableOptional
get/api/v2/hosts/{host_id}/processes/{uid}
GET /api/v2/hosts/{host_id}/processes/{uid} HTTP/1.1
Accept: */*
{
  "process_id": 1,
  "process_name": "text",
  "host_id": 1,
  "architecture": "text",
  "user": "text",
  "stale": true,
  "agent_id": "text"
}

Read Processes

get
Path parameters
host_idintegerRequired
Responses
200

Successful Response

application/json
get/api/v2/hosts/{host_id}/processes
GET /api/v2/hosts/{host_id}/processes HTTP/1.1
Accept: */*
{
  "records": [
    {
      "process_id": 1,
      "process_name": "text",
      "host_id": 1,
      "architecture": "text",
      "user": "text",
      "stale": true,
      "agent_id": "text"
    }
  ]
}

Last updated

Was this helpful?