Skip to main content
ZStack
Recently Deleted/Recently Deleted

UpdateManagedAgentCapabilities

Submit the entire ordered capability change list with agent.config.write permission and a valid five-minute precheck. Only host_metrics is supported in this release. Returns one change_capabilities task with no bindingId; repeated requests recover that task without repeating Agent operations. Successful items are retained if a later item fails. An entirely unchanged request returns noOp without creating a task. desiredState and effectiveState are single-change compatibility fields and remain empty for multiple changes.

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

Operation ID

UpdateManagedAgentCapabilities

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

  • precheckId
    String

    Precheck id for this resource

    Example: value

  • changes
    List

    Non-empty list with unique capability IDs; every item must be supported and valid. Only host_metrics is currently implemented. One task executes the entire request; successful items are retained if a later item fails.

    Example: (nested array)

    • capabilityId
      String

      Capability id for this resource

      Example: value

    • desiredState
      String

      Desired state for this resource

      Example: value

    • configurationRevision
      String

      Update only: a certified configuration version, never raw Collector YAML.

      Example: value

    • drainMode
      String

      Disable only. Initial enable/resume omits both optional fields.

      Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task id for this resource

    Example: value

  • state
    String

    Persisted task state, including the original state on request replay.

    Example: value

  • desiredState
    String

    Single-change requested state; empty for multiple changes.

    Example: value

  • noOp
    Boolean

    True when the requested configuration is unchanged and no task is created.

    Example: true

  • effectiveState
    String

    Saved capability state of a single-change no-op; absent for multiple changes.

    Example: value