@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias ChangeClusterModeAsClusterAdminData

    type ChangeClusterModeAsClusterAdminData = {
        body?: never;
        path?: never;
        query: { dryRun?: boolean; mode: Mode; physicalTenantId?: string };
        url: "/cluster/v2/mode";
    }
    Index
    body? path? query url

    Optionalbody

    body?: never
    path?: never
    query: { dryRun?: boolean; mode: Mode; physicalTenantId?: string }

    Type Declaration

    • OptionaldryRun?: boolean

      If true, the requested change is only validated and the resulting plan is returned, without applying it to the cluster.

    • mode: Mode

      The target cluster mode.

    • OptionalphysicalTenantId?: string

      The physical tenant to apply the change to. When omitted, or when passed with an empty value, the change is applied to every physical tenant of the cluster.

    url: "/cluster/v2/mode"

    Settings
    Member Visibility

    On This Page
    Properties