Settings API - Connection settings schema table

    Connection settings (builtin:cloud.kubernetes)

    Connect to Kubernetes or OpenShift for enhanced observability. Learn more about Kubernetes or OpenShift in our documentation.

    Schema IDSchema groupsScope
    builtin:cloud.kubernetes-
    KUBERNETES_CLUSTER - Kubernetes cluster
    GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes
    SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:cloud.kubernetes
    Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes

    Authentication

    To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

    Parameters

    PropertyTypeDescriptionRequired
    Enabled
    enabled    		boolean-required
    Name
    label    		text

    Renaming the cluster breaks configurations that are based on its name (e.g., management zones, and alerting).

    		required
    Connect containerized ActiveGate to local Kubernetes API endpoint
    clusterIdEnabled    		boolean

    For more information on local Kubernetes API monitoring, see the documentation.

    Enable this toggle when the ActiveGate is deployed to the same Kubernetes clusters you want to monitor. Disable it if you want to monitor a different Kubernetes cluster.

    		required
    Kubernetes cluster ID
    clusterId    		text

    Unique ID of the cluster, the containerized ActiveGate is deployed to. Defaults to the UUID of the kube-system namespace. The cluster ID of containerized ActiveGates is shown on the Deployment status screen.

    		required
    Kubernetes API URL Target
    endpointUrl    		text

    Get the API URL for Kubernetes or OpenShift.

    		required
    Kubernetes Bearer Token
    authToken    		secret

    Create a bearer token for Kubernetes or OpenShift.

    		required
    ActiveGate Group
    activeGateGroup    		text-optional
    Require valid certificates for communication with API server (recommended)
    certificateCheckEnabled    		boolean-required
    Verify hostname in certificate against Kubernetes API URL
    hostnameVerificationEnabled    		boolean-required