Agent

Retrieves an individual agent based on the provided agentID.

Returns the requested agent when access is allowed.

get/v1/agent/{agentID}

Request

  • Base URL: https://api.actionstreamer.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.actionstreamer.com/v1/agent/{agentID}
  • Auth: none declared

Path parameters

agentIDinteger required
Example:1

The unique identifier of the agent to retrieve.

Response

Success

keyinteger
deviceIDinteger
agentTypeIDinteger
agentIndexinteger
currentEventIDinteger
processIDinteger
versionstring nullable
agentNamestring nullable
agentDescriptionstring nullable
recentOutputstring nullable
lastHeardFromDatestring date-time nullable
creationDatestring date-time nullable

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.