Retrieves an individual agent based on the provided agentID
GET /v1/agent/{agentID}
Summary
Retrieves an individual agent based on the provided agentID.
Details
Returns the requested agent when access is allowed.
Authentication
No operation-level security requirement is documented here.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
| agentID | path | integer (int64) | Yes | The unique identifier of the agent to retrieve. | 1 |
Request Body
No request body is documented here.
Responses
200
Success
text/plain
key(integer (int64), optional)deviceID(integer (int64), optional)agentTypeID(integer (int64), optional)agentIndex(integer (int64), optional)currentEventID(integer (int64), optional)processID(integer (int64), optional)version(string, optional)agentName(string, optional)agentDescription(string, optional)recentOutput(string, optional)lastHeardFromDate(string (date-time), optional)creationDate(string (date-time), optional)
application/json
key(integer (int64), optional)deviceID(integer (int64), optional)agentTypeID(integer (int64), optional)agentIndex(integer (int64), optional)currentEventID(integer (int64), optional)processID(integer (int64), optional)version(string, optional)agentName(string, optional)agentDescription(string, optional)recentOutput(string, optional)lastHeardFromDate(string (date-time), optional)creationDate(string (date-time), optional)
Example
{
"key": 1,
"deviceID": 201,
"agentTypeID": 1,
"agentIndex": 1,
"currentEventID": 501,
"processID": 4321,
"version": "1.0.0",
"agentName": "Example value",
"agentDescription": "Example description",
"recentOutput": "Agent started successfully.",
"lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
"creationDate": "2026-03-30T12:00:00.0000000Z"
}
text/json
key(integer (int64), optional)deviceID(integer (int64), optional)agentTypeID(integer (int64), optional)agentIndex(integer (int64), optional)currentEventID(integer (int64), optional)processID(integer (int64), optional)version(string, optional)agentName(string, optional)agentDescription(string, optional)recentOutput(string, optional)lastHeardFromDate(string (date-time), optional)creationDate(string (date-time), optional)