Embedded APIResourcesOn-prem

Search On-prem Agents

Finds On-prem Agents in a customer workspace by common name.

Path parameters

idstringRequired

Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

cnstringRequired

Common name of the On-prem agent you plan to use for the search.

Response

Success - On-prem agents matching the search criteria were retrieved successfully.

idinteger or null

The unique identifier for the On-prem Agent.

on_prem_group_idinteger or null

The ID of the On-prem group the agent belongs to.

namestring or null

The common name of the On-prem Agent.

cnstring or null

The full common name identifier of the On-prem Agent.

osstring or null

The operating system of the On-prem Agent.

awaiting_setupboolean or null

Indicates if the On-prem Agent is awaiting setup.

enabledboolean or null

Indicates if the On-prem Agent is currently enabled.

Errors