Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface ListBackupsOptions

    The options for listing backups.

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

    Only applies when indexName is provided. When true, returns backups from every index in the project that has ever used this name, including deleted indexes. When false or omitted, indexName must resolve to an active index or the API returns a 404. Ignored when listing all project backups.

    indexName?: string

    The index name to list backups for. If not provided, all project backups will be listed.

    limit?: number

    Maximum number of backups to return.

    paginationToken?: string

    Token used for pagination to retrieve the next page of results.

    Settings
    Member Visibility

    On This Page
    Properties