Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Interface ListBackupsOptions

    Options for the deprecated flat backup listing method.

    Use ListIndexBackupsOptions with Backups.listByIndex, or ListProjectBackupsOptions with Backups.list.

    interface ListBackupsOptions {
        includeDeleted?: boolean;
        indexName?: string;
        limit?: number;
        paginationToken?: string;
    }

    Hierarchy (View Summary)

    Index
    includeDeleted? indexName? limit? paginationToken?
    includeDeleted?: boolean

    When true, returns backups from every index in the project that has ever used this name, including deleted ones. Backups from a deleted index carry a sourceIndexDeletedAt timestamp.

    When false or omitted, indexName must resolve to an active index; if only deleted indexes have used the name, the API returns a 404 rather than an empty list.

    indexName?: string

    Omit to list all project backups.

    limit?: number

    Maximum number of results per page. Omit to use the service default.

    paginationToken?: string

    Pagination token from a prior response to retrieve the next page.

    Settings
    Member Visibility

    On This Page
    Properties