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

    Type Alias RestoreAsClusterAdminData

    type RestoreAsClusterAdminData = {
        body: ClusterRestoreRequest;
        path?: never;
        query?: { dryRun?: boolean; physicalTenantId?: string };
        url: "/cluster/v2/restore";
    }
    Index
    body path? query? url

    body

    body: ClusterRestoreRequest
    path?: never
    query?: { dryRun?: boolean; 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.

    • 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/restore"

    Settings
    Member Visibility

    On This Page
    Properties