Skip to main content
ZStack
Recently Deleted/Recently Deleted

UpdateManagedAgent

Update displayName and/or agentLifecycleAlertDestination selected by updateMask. Requires agent.config.write in the stored Agent scope and active platform access; offline Agents may be updated. The last committed value wins. requestId is for tracing, not response replay. No task or remote configuration is created.

PATCH/api/v1/lifecycle/managed-agent/agents/{id}

Operation ID

UpdateManagedAgent

Since

1.3.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • id
    StringRequired

    Unique identifier of the managed agent

Body Fields

  • requestId
    String

    Request id for this resource

    Example: value

  • updateMask
    List

    Nonempty subset of displayName and agentLifecycleAlertDestination. Unselected fields are ignored. Duplicate or unknown paths are rejected.

    Example: item1,item2

  • displayName
    String

    Display name for this resource

    Example: value

  • agentLifecycleAlertDestination
    String

    zmetis or none. Applies only when selected by update_mask.

    Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • agentId
    String

    Agent id for this resource

    Example: value

  • displayName
    String

    Display name for this resource

    Example: value

  • agentLifecycleAlertDestination
    String

    Agent lifecycle alert destination for this resource

    Example: value

  • rowVersion
    String

    Row version for this resource

    Example: 10