Skip to main content
ZStack
Recently Deleted/Recently Deleted

GetManagedAgentConfigurationOptions

Read certified configuration choices for this Agent's registered version and platform. Requires agent.read and agent.config.write in its stored scope. Missing Agent or denied read scope returns 404; denied configuration permission returns 403; unavailable dependencies return 503. An empty items array means no applicable configuration. Effective configuration is resolved from the applied history, not the pending target, and may no longer be selectable. Metadata only: no YAML, credentials, tasks or runtime probes. Prechecks remain required before updates.

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

Operation ID

GetManagedAgentConfigurationOptions

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

    Agent UUID from the Agent list or registration result.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • capabilities
    List

    All currently supported capabilities, including those without a Binding.

    Example: (nested array)

    • capabilityId
      String

      Capability identifier; currently host_metrics.

      Example: value

    • effectiveConfigurationRevision
      String

      Applied template revision, e.g. host/v1; absent before any effective config. This is not the numeric config sequence and need not be present in items.

      Example: value

    • items
      List

      Applicable certified templates. Current policy selects zero or one item.

      Example: (nested array)

      • configurationRevision
        String

        Template provider_revision, supplied as configurationRevision on updates.

        Example: value

      • displayName
        String

        Human-readable template name from managed-agent.yaml.

        Example: value

      • description
        String

        Brief template description; empty when not configured.

        Example: A brief description