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

    Interface BackupScheduleModel

    The configuration and status of a backup schedule.

    nextScheduledRun is null while the schedule is disabled; re-enabling it recomputes the next run from the moment of the update.

    Backups

    interface BackupScheduleModel {
        createdAt: Date;
        enabled: boolean;
        frequency: string & {} | BackupScheduleFrequency;
        indexId: string;
        name: string;
        nextScheduledRun: Date | null;
        projectId: string;
        retentionExpireAfterDays: number;
        scheduleId: string;
        scheduleType: string;
    }

    Hierarchy

    • Omit<BackupScheduleResponse, "frequency">
      • BackupScheduleModel
    Index
    createdAt enabled frequency indexId name nextScheduledRun projectId retentionExpireAfterDays scheduleId scheduleType
    createdAt: Date

    RFC 3339 timestamp when the schedule was created.

    BackupScheduleResponse

    enabled: boolean

    Whether the schedule is active. Disabled schedules do not run.

    BackupScheduleResponse

    frequency: string & {} | BackupScheduleFrequency

    How often the schedule runs.

    indexId: string

    ID of the index this schedule backs up.

    BackupScheduleResponse

    name: string

    User-defined name for the backup schedule.

    BackupScheduleResponse

    nextScheduledRun: Date | null

    Always present. RFC 3339 timestamp of the next planned backup run when enabled is true. null when enabled is false; no backup is scheduled until the schedule is re-enabled.

    BackupScheduleResponse

    projectId: string

    Pinecone project that contains this schedule (same project as the source index).

    BackupScheduleResponse

    retentionExpireAfterDays: number

    Number of days backups created by this schedule are retained.

    BackupScheduleResponse

    scheduleId: string

    Unique identifier for the backup schedule.

    BackupScheduleResponse

    scheduleType: string

    Schedule category. Only time-based schedules are supported.

    BackupScheduleResponse

    Settings
    Member Visibility

    On This Page
    Properties