Agent

List agents

Lists the agents associated with an organization

  • Requires the action agent:List on the organization
get/api/v1/org/{orgUID}/agent/

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/agent/
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Query parameters

agent_registration_uid_equalsstring
is_archivedboolean
is_not_archivedboolean
original_associationboolean
pageinteger
page_sizeinteger
source_uid_equalsstring

Response

OK

agent_registration_uidstring

Agent registration associated with the agent

agent_typeinteger

Agent type

agent_versionstring

Version of the agent installed

agent_work_idinteger

Agent work Id

archivedboolean

Is the agent archived?

descriptionstring

Description of the purpose of the agent

kernel_versionstring

Kernel version of the installed system

live_test_raninteger

Did the live test run?

live_test_resultinteger

Result of the live test

muidstring

Muid created on by the agent on the system

org_uidstring

Agent OrgUID

os_pretty_namestring

Pretty name of the operating system the agent is installed on

resource_namestring

Resource name used for RBAC

runtime_descriptionstring

Description of the runtime of the agent

standbyboolean

Is the agent in standby mode?

uidstring

Agent UID

user_work_idinteger
valid_fromstring date-time

Valid from date, the first date this object was valid

valid_tostring date-time

Valid to date, the date this object is valid to

Changes

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