Embedded APIResourcesOn-prem

Update On-prem Agent

Updates 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.

Request

This endpoint expects an object.
namestringRequired

The updated name of the On-prem agent.

osstringRequired
The updated server operating system.
on_prem_group_idintegerRequired

The On-prem group ID to associate this agent with. See List On-prem groups.

Response

Success - The On-prem agent was updated successfully.

idstring or null

The unique identifier of the updated On-prem agent.

namestring or null

The updated name of the On-prem agent.

osstring or null
The updated server operating system.
on_prem_group_idinteger or null

The On-prem group ID associated with this agent.

updated_atdatetime or null

Timestamp when the On-prem agent was last updated.

Errors