Skip to main content
ZStack
Recently Deleted/Recently Deleted

GetManagedAgentAvailability

Read installation, host_metrics and operation gates under the current compatibility revision. Requires agent.read and permissions for the selected optional platform/Region scope, including unassociated Agents; denied scopes return PermissionDenied. Does not grant write permissions or replace per-Agent prechecks. Runtime unavailability does not prevent server-side access revocation.

GET/api/v1/lifecycle/managed-agent/availability

Operation ID

GetManagedAgentAvailability

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

Query Parameters

  • platformUuid
    String

    Filter availability by platform UUID

  • regionUuid
    String

    Filter availability by region UUID

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • scope
    Object

    Scope for this resource

    • platformUuid
      String

      Platform uuid for this resource

      Example: value

    • regionUuid
      String

      Region uuid for this resource

      Example: value

  • compatibilityRevision
    String

    Compatibility revision for this resource

    Example: value

  • install
    Object

    Install 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

    • available
      Boolean

      Available for this resource

      Example: true

    • blockedBy
      List

      Stable readiness/certification reasons, never raw dependency errors.

      Example: item1,item2

  • 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

Change History

View all change history

  • Change Time

    AddedResponse fields targetAgentRelease
    View API