Skip to main content
ZStack
Recently Deleted/Recently Deleted

GetManagedAgentTask

Read scoped Agent task progress with agent.read permission. Retry availability additionally requires agent.config.write. A successful access revocation may return the trusted package's local uninstall command; no remote uninstall is performed.

GET/api/v1/lifecycle/managed-agent/tasks/{id}

Operation ID

GetManagedAgentTask

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

Path Parameters

  • id
    StringRequired

    Unique identifier of the managed agent task

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task id for this resource

    Example: value

  • type
    String

    Saved operation type, such as deploy, change_capabilities, enable_capability, disable_capability, upgrade or revoke_access.

    Example: enable_capability

  • state
    String

    State for this resource

    Example: value

  • agentId
    String

    Agent id for this resource

    Example: value

  • invitationId
    String

    Invitation id for this resource

    Example: value

  • bindingId
    String

    Binding id for this resource

    Example: value

  • requestId
    String

    Request id for this resource

    Example: value

  • createdBy
    String

    Created by for this resource

    Example: value

  • availableActions
    List

    Available actions for this resource

    Example: item1,item2

  • waitingReason
    String

    Waiting reason for this resource

    Example: value

  • plannedImpact
    Object

    Typed historical impact for access revocation and capability disable.

    • platformAccessRevoked
      Boolean

      Platform access revoked for this resource

      Example: true

    • localBacklogMayNotUpload
      Boolean

      Local backlog may not upload for this resource

      Example: true

    • localAgentUninstalled
      Boolean

      Local agent uninstalled for this resource

      Example: true

    • metricsContinuity
      String

      buffered, unprotected or unknown; restart reports unknown. Empty for access revocation.

      Example: value

    • resumeCollection
      Boolean

      Resume collection for this resource

      Example: true

    • drainMode
      String

      Disable only: wait or discard.

      Example: value

    • drainWaitSeconds
      Integer

      Fixed at 1800 for wait; absent for discard.

      Example: 10

    • cancelledEnableTaskId
      String

      Cancelled enable task id for this resource

      Example: value

    • queueFacts
      Object

      Queue facts for this resource

      • queueSize
        Long

        Queue size for this resource

        Example: 0

      • queueCapacity
        Long

        Queue capacity for this resource

        Example: 0

      • enqueueFailedMetricPoints
        Long

        Enqueue failed metric points for this resource

        Example: 0

      • sendFailedMetricPoints
        Long

        Send failed metric points for this resource

        Example: 0

      • sentMetricPoints
        Long

        Sent metric points for this resource

        Example: 0

      • serviceInstanceId
        String

        Service instance id for this resource

        Example: value

      • observedAt
        String

        Observed at for this resource

        Example: 2026-01-15T08:00:00Z

    • collectorRestart
      Boolean

      Restart and Upgrade affect the Collector; Restart leaves its Supervisor.

      Example: true

    • agentRestart
      Boolean

      Upgrade only: complete Agent package, including its Supervisor.

      Example: true

    • previousAgentVersion
      String

      Previous agent version for this resource

      Example: value

    • targetAgentVersion
      String

      Target agent version for this resource

      Example: value

    • previousAgentRelease
      String

      Previous agent release for this resource

      Example: 10

    • targetAgentRelease
      String

      Target agent release for this resource

      Example: 10

  • actualImpact
    Object

    Actual impact for this resource

    • platformAccessRevoked
      Boolean

      Platform access revoked for this resource

      Example: true

    • localBacklogMayNotUpload
      Boolean

      Local backlog may not upload for this resource

      Example: true

    • localAgentUninstalled
      Boolean

      Local agent uninstalled for this resource

      Example: true

    • metricsContinuity
      String

      buffered, unprotected or unknown; restart reports unknown. Empty for access revocation.

      Example: value

    • resumeCollection
      Boolean

      Resume collection for this resource

      Example: true

    • drainMode
      String

      Disable only: wait or discard.

      Example: value

    • drainWaitSeconds
      Integer

      Fixed at 1800 for wait; absent for discard.

      Example: 10

    • cancelledEnableTaskId
      String

      Cancelled enable task id for this resource

      Example: value

    • queueFacts
      Object

      Queue facts for this resource

      • queueSize
        Long

        Queue size for this resource

        Example: 0

      • queueCapacity
        Long

        Queue capacity for this resource

        Example: 0

      • enqueueFailedMetricPoints
        Long

        Enqueue failed metric points for this resource

        Example: 0

      • sendFailedMetricPoints
        Long

        Send failed metric points for this resource

        Example: 0

      • sentMetricPoints
        Long

        Sent metric points for this resource

        Example: 0

      • serviceInstanceId
        String

        Service instance id for this resource

        Example: value

      • observedAt
        String

        Observed at for this resource

        Example: 2026-01-15T08:00:00Z

    • collectorRestart
      Boolean

      Restart and Upgrade affect the Collector; Restart leaves its Supervisor.

      Example: true

    • agentRestart
      Boolean

      Upgrade only: complete Agent package, including its Supervisor.

      Example: true

    • previousAgentVersion
      String

      Previous agent version for this resource

      Example: value

    • targetAgentVersion
      String

      Target agent version for this resource

      Example: value

    • previousAgentRelease
      String

      Previous agent release for this resource

      Example: 10

    • targetAgentRelease
      String

      Target agent release for this resource

      Example: 10

  • errorCode
    String

    Error code for this resource

    Example: value

  • errorReason
    String

    Error reason for this resource

    Example: value

  • errorMessage
    String

    Error message for this resource

    Example: value

  • errorDetails
    Object

    Error details for this resource

    • deployment_phase
      String

      Deployment_phase for this resource

      Example: value

    • invitation_consumed
      Boolean

      Invitation_consumed for this resource

      Example: true

    • registered_agent_id
      Object

      The server emits only a string or JSON null, never a reserved Agent ID.

    • recovery_action
      String

      Recovery_action for this resource

      Example: value

  • traceId
    String

    Trace id for this resource

    Example: value

  • createdAt
    String

    Created at for this resource

    Example: 2026-01-15T08:00:00Z

  • startedAt
    String

    Started at for this resource

    Example: 2026-01-15T08:00:00Z

  • completedAt
    String

    Completed at for this resource

    Example: 2026-01-15T08:00:00Z

  • resultMessage
    String

    Present only for a successful revoke_access task and trusted metadata.

    Example: value

  • localUninstallCommand
    String

    Local uninstall command for this resource

    Example: value

  • cancelReason
    String

    Cancel reason for this resource

    Example: value

  • cancelledByTaskId
    String

    Cancelled by task id for this resource

    Example: value

  • hostMetricContinuitySummary
    Object

    Present only for host_metrics capability tasks; not an Agent health state.

    • lastHostMetricAt
      String

      Last host metric at for this resource

      Example: 2026-01-15T08:00:00Z

    • collectionState
      String

      collecting, stopped or unknown; independent of business sample age.

      Example: value

    • deliveryState
      String

      current, delayed, backfilling or unknown; never an exact data gap.

      Example: value

    • queueSize
      Long

      Upstream queue units, not a count of metric samples or bytes.

      Example: 0

    • queueCapacity
      Long

      Queue capacity for this resource

      Example: 0

    • enqueueFailedMetricPoints
      Long

      Enqueue failed metric points for this resource

      Example: 0

    • sendFailedMetricPoints
      Long

      Send failed metric points for this resource

      Example: 0

    • sentMetricPoints
      Long

      Sent metric points for this resource

      Example: 0

    • serviceInstanceId
      String

      Service instance id for this resource

      Example: value

    • observedAt
      String

      Observed at for this resource

      Example: 2026-01-15T08:00:00Z

  • configRevision
    String

    Current configuration delivery owned by this task, including rollback. Absent until the Runner generates a configuration; never a Binding lookup.

    Example: 10

  • observed
    Object

    Present only for a wait-mode Disable with a saved drain window.

    • drainWaitSeconds
      Integer

      Drain wait seconds for this resource

      Example: 10

    • drainStartedAt
      String

      Drain started at for this resource

      Example: 2026-01-15T08:00:00Z

    • drainDeadlineAt
      String

      Drain deadline at for this resource

      Example: 2026-01-15T08:00:00Z

    • queueFacts
      Object

      Last valid saved queue observation; absent when no observation was saved.

      • queueSize
        Long

        Queue size for this resource

        Example: 0

      • queueCapacity
        Long

        Queue capacity for this resource

        Example: 0

      • enqueueFailedMetricPoints
        Long

        Enqueue failed metric points for this resource

        Example: 0

      • sendFailedMetricPoints
        Long

        Send failed metric points for this resource

        Example: 0

      • sentMetricPoints
        Long

        Sent metric points for this resource

        Example: 0

      • serviceInstanceId
        String

        Service instance id for this resource

        Example: value

      • observedAt
        String

        Observed at for this resource

        Example: 2026-01-15T08:00:00Z

Change History

View all change history

  • Change Time

    AddedResponse fields previousAgentRelease, targetAgentRelease
    View API