Skip to main content
PATCH
Update an on-premise agent.

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

id
integer<int32>
required

The identifier of the agent to update.

Body

application/json

The members to change. Omitted members are left as they are.

Partial update for an on-premise agent. A null member is left unchanged; this is a merge, not a replace - deliberately unlike PUT /v1/connections, which replaces its whole field map.

name
string | null

New display name; null leaves it unchanged.

description
string | null

New description; null leaves it unchanged.

settings
object | null

Runtime settings to merge in; null members are left unchanged.

Response

The updated agent, plus whether the settings reached the running agent.

Full detail for one on-premise agent.

agentId
integer<int32>
required

Identifier of the agent.

status
string
required

Liveness of the agent: WaitingForConnection, Online, Offline or Disabled.

createdBy
string<uuid>
required

Identifier of the user who created the agent.

createdDate
string<date-time>
required

When the agent was created.

name
string | null

Display name of the agent.

description
string | null

Optional description of the agent.

version
string | null

Version the agent last self-reported. Null until it first connects.

lastSeenAt
string<date-time> | null

Last heartbeat received from the agent. Null when it has never connected.

updatedBy
string<uuid> | null

Identifier of the user who last updated the agent.

updatedDate
string<date-time> | null

When the agent was last updated.

settings
object

Runtime settings currently stored for the agent.

appliedToAgent
boolean | null

False when a settings write reached the database but not the agent, because the agent was Offline. Null on reads - only set by update responses.

dispatchedTaskIds
string[] | null

Cloud task identifiers dispatched to the live agent by a settings write. Empty when offline.