Skip to main content
ZStack
Recently Deleted/Recently Deleted

GetManagedAgent

Read Agent details with agent.read in its stored scope. Includes operation availability, capability and certificate summaries, and task references. Metrics query failure leaves continuity unknown without changing Agent health or tasks. Revoked access does not imply local uninstallation.

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

Operation ID

GetManagedAgent

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

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

  • scope
    Object

    Scope for this resource

    • platformUuid
      String

      Platform uuid for this resource

      Example: value

    • regionUuid
      String

      Region uuid for this resource

      Example: value

  • agentVersion
    String

    Agent version for this resource

    Example: value

  • accessState
    String

    Access state for this resource

    Example: value

  • healthStatus
    String

    Health status for this resource

    Example: value

  • runtimeState
    String

    Runtime state for this resource

    Example: value

  • primaryStatus
    String

    Primary status for this resource

    Example: value

  • agentLifecycleAlertDestination
    String

    Agent lifecycle alert destination for this resource

    Example: value

  • effectiveConfigRevision
    String

    Effective config revision for this resource

    Example: 10

  • lastHeartbeatAt
    String

    Last heartbeat at for this resource

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

  • lastStatusChangedAt
    String

    Last status changed at for this resource

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

  • rowVersion
    String

    Row version for this resource

    Example: 10

  • technicalDetails
    Object

    Technical details for this resource

    • agentKind
      String

      Agent kind for this resource

      Example: value

    • managementOwner
      String

      Management owner for this resource

      Example: value

  • operations
    Object

    Operations for this resource

    • restart
      Object

      Restart for this resource

      • available
        Boolean

        Available for this resource

        Example: true

      • blockedBy
        List

        Blocked by for this resource

        Example: item1,item2

      • targetAgentVersion
        String

        Target agent version for this resource

        Example: value

      • targetAgentRelease
        String

        Target agent release for this resource

        Example: 10

    • upgrade
      Object

      Upgrade for this resource

      • available
        Boolean

        Available for this resource

        Example: true

      • blockedBy
        List

        Blocked by for this resource

        Example: item1,item2

      • targetAgentVersion
        String

        Target agent version for this resource

        Example: value

      • targetAgentRelease
        String

        Target agent release for this resource

        Example: 10

    • revokeAccess
      Object

      Revoke access for this resource

      • available
        Boolean

        Available for this resource

        Example: true

      • blockedBy
        List

        Blocked by for this resource

        Example: item1,item2

      • targetAgentVersion
        String

        Target agent version for this resource

        Example: value

      • targetAgentRelease
        String

        Target agent release for this resource

        Example: 10

  • capabilities
    List

    Capabilities for this resource

    Example: (nested array)

    • capabilityId
      String

      Capability id for this resource

      Example: value

    • displayName
      String

      Display name for this resource

      Example: value

    • available
      Boolean

      Available for this resource

      Example: true

    • blockedBy
      List

      Blocked by for this resource

      Example: item1,item2

    • bindingId
      String

      Absent before this capability has a persisted Binding.

      Example: value

    • desiredState
      String

      Desired state for this resource

      Example: value

    • effectiveState
      String

      Effective state for this resource

      Example: value

    • providerId
      String

      Provider id for this resource

      Example: value

    • providerRevision
      String

      Provider revision for this resource

      Example: value

    • currentConfigRevision
      String

      Current config revision for this resource

      Example: 10

    • effectiveConfigRevision
      String

      Effective config revision for this resource

      Example: 10

    • rowVersion
      String

      Row version for this resource

      Example: 10

    • lastObservedAt
      String

      Last observed at for this resource

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

    • lastErrorReason
      String

      Last error reason for this resource

      Example: value

    • hostMetricContinuitySummary
      Object

      Host metric continuity summary for this resource

      • 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

  • certificates
    List

    Certificates for this resource

    Example: (nested array)

    • certificateId
      String

      Certificate id for this resource

      Example: value

    • purpose
      String

      Purpose for this resource

      Example: value

    • status
      String

      Status for this resource

      Example: value

    • notBefore
      String

      Not before for this resource

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

    • notAfter
      String

      Not after for this resource

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

    • activationDeadline
      String

      Activation deadline for this resource

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

    • revokedAt
      String

      Revoked at for this resource

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

    • revokeReason
      String

      Revoke reason for this resource

      Example: value

  • activeTasks
    List

    Active tasks for this resource

    Example: (nested array)

    • taskId
      String

      Task id for this resource

      Example: value

    • type
      String

      Business operation represented by the referenced Agent task: deploy, change_capabilities, enable_capability, update_capability, disable_capability, restart_runtime, upgrade, renew_certificate, or revoke_access.

      Example: value

    • state
      String

      State for this resource

      Example: value

    • bindingId
      String

      Binding 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

    • errorReason
      String

      Saved, sanitized task errors; never inferred from Agent primary status.

      Example: value

    • errorMessage
      String

      Error message for this resource

      Example: value

    • availableActions
      List

      Computed from current task facts and caller permissions, not persisted.

      Example: item1,item2

    • waitingReason
      String

      Waiting reason for this resource

      Example: value

  • accessRevocationTask
    Object

    Original successful revocation; read the task resource for its full result.

    • taskId
      String

      Task id for this resource

      Example: value

    • type
      String

      Business operation represented by the referenced Agent task: deploy, change_capabilities, enable_capability, update_capability, disable_capability, restart_runtime, upgrade, renew_certificate, or revoke_access.

      Example: value

    • state
      String

      State for this resource

      Example: value

    • bindingId
      String

      Binding 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

    • errorReason
      String

      Saved, sanitized task errors; never inferred from Agent primary status.

      Example: value

    • errorMessage
      String

      Error message for this resource

      Example: value

    • availableActions
      List

      Computed from current task facts and caller permissions, not persisted.

      Example: item1,item2

    • waitingReason
      String

      Waiting reason for this resource

      Example: value

  • accessRevokingAt
    String

    Access revoking at for this resource

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

  • accessRevokedAt
    String

    Access revoked at for this resource

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

  • accessRevokedBy
    String

    Access revoked by for this resource

    Example: value

  • accessRevokeReason
    String

    Access revoke reason for this resource

    Example: value

  • localUninstallCommand
    String

    Trusted historical package metadata only, after logical access revocation.

    Example: value

  • updateAvailable
    Boolean

    Whether a certified target release is available; this does not authorize an upgrade.

    Example: true

  • createdAt
    String

    Created at for this resource

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

  • updatedAt
    String

    Updated at for this resource

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

  • agentRelease
    String

    Agent release for this resource

    Example: 10

Change History

View all change history

  • Change Time

    AddedResponse fields agentRelease, targetAgentRelease
    View API