Interface DriveInterface

Drive entity interface

Mirrors macs-node-sdk/lib/drive/models/drive.js. current_size is server- tracked.

interface DriveInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    name: string;
    description?: string;
    current_size?: number;
    max_size?: number;
    status?: string;
    public?: boolean;
    retention_policy?: DriveRetentionPolicy;
    monitoring_enabled?: boolean;
    quota_alert_threshold?: number;
    critical_quota_threshold?: number;
    audit_logging_enabled?: boolean;
    active?: boolean;
    items?: any;
    uploads?: any;
    indexes?: any;
}

Hierarchy (View Summary)

Properties

external_id? extensors? record_history? id? org? user? name description? current_size? max_size? status? public? retention_policy? monitoring_enabled? quota_alert_threshold? critical_quota_threshold? audit_logging_enabled? active? items? uploads? indexes?

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

name

name: string

Drive name (required, maxlength 255)

Optionaldescription

description?: string

Description (maxlength 1000)

Optional Readonlycurrent_size

current_size?: number

Bytes currently stored — server-managed

Optionalmax_size

max_size?: number

Quota in bytes. Default 1 GiB.

Optionalstatus

status?: string

Storage status (see STORAGE_STATUS constant). Default 'ACTIVE'.

Optionalpublic

public?: boolean

Whether the drive allows public read without auth

Optionalretention_policy

retention_policy?: DriveRetentionPolicy

Retention policy config

Optionalmonitoring_enabled

monitoring_enabled?: boolean

Whether storage monitoring is enabled

Optionalquota_alert_threshold

quota_alert_threshold?: number

Quota usage % that triggers a warning alert (1–100, default 80)

Optionalcritical_quota_threshold

critical_quota_threshold?: number

Quota usage % that triggers a critical alert (1–100, default 95)

Optionalaudit_logging_enabled

audit_logging_enabled?: boolean

Whether audit logging is enabled for drive operations

Optionalactive

active?: boolean

Whether the entity is active

Optional Readonlyitems

items?: any

Optional Readonlyuploads

uploads?: any

Optional Readonlyindexes

indexes?: any

Settings

Member Visibility

On This Page

Properties