Skip to main content
GET
List Agent Keys

Query Parameters

status
string

Filter by status (CONNECTED or DISCONNECTED)

Response

OK

compiler
string
Example:

"gcc"

goversion
string
Example:

"1.22.4"

hostname
string

DEPRECATE top level metadata keys

Example:

"john.wick.local"

id
string<uuid>

Unique ID of the resource

Example:

"8a4239fa-5116-4bbb-ad3c-ea1f294aac4a"

kernel_version
string
Example:

"Linux 9acfe93d8195 5.15.49-linuxkit"

machine_id
string
Example:

""

metadata
object

Metadata contains attributes regarding the machine where the agent is being executed

  • version - Version of the agent
  • go-version - Agent build information
  • compiler - Agent build information
  • platform - The operating system architecture where the agent is running
  • machine-id - The machine id of server
  • kernel-version - The kernel version of the server
Example:
mode
enum<string>

Mode of execution of the agent

  • standard - Is the default mode, which is suitable to run the agent as a standalone process
  • embedded - This mode is suitable when the agent needs to be run close to another process or application
Available options:
standard,
embedded
Example:

"standard"

name
string

Unique name of the resource

Example:

"default"

platform
string
Example:

"amd64"

status
enum<string>

The status of the agent

  • CONNECTED - The agent is connected with the gateway
  • DISCONNECTED - The agent is disconnected from the gateway
Available options:
CONNECTED,
DISCONNECTED
Example:

"DISCONNECTED"

token
string

The token/key of the resource, this value is always empty for now

version
string
Example:

"1.23.10"