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

    Type Alias ListHistoryBackupsAsClusterAdminData

    type ListHistoryBackupsAsClusterAdminData = {
        body?: never;
        path?: never;
        query?: {
            physicalTenantId?: string;
            prefix?: BackupIdPrefix;
            verbose?: boolean;
        };
        url: "/cluster/v2/backups/history";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        physicalTenantId?: string;
        prefix?: BackupIdPrefix;
        verbose?: boolean;
    }

    Type Declaration

    • 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.

    • Optionalprefix?: BackupIdPrefix

      A prefix that backup ids must match, ending in a single '*'. If omitted, all backups are returned.

    • Optionalverbose?: boolean

      Whether to ask the secondary storage for snapshot-level detail. Setting this to false makes the query cheaper, but the store then reports neither snapshot state nor start time, so both the per-snapshot details and the per-tenant state are incomplete and the listing order is unspecified.

    url: "/cluster/v2/backups/history"

    Settings
    Member Visibility

    On This Page
    Properties