Get On-prem Agent status

Retrieves the status of an On-prem agent in a customer workspace.

Path parameters

idstringRequired

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

agent_idstringRequired

The unique ID of the On-prem agent.

Headers

AuthorizationstringRequired

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

Response

Success - The On-prem agent status was retrieved successfully.

activeboolean or null

Indicates whether the On-prem Agent is active or not.

Errors