---
title: "Update Drive"
method: PUT
path: "/2/drive/{drive_id}"
tags: ["Drive"]
---

# Update Drive

`PUT /2/drive/{drive_id}`

Update Drive from a Drive identifier

## Path parameters

- `drive_id` integer, required

## Request body

- object
  - `bill_reference` string, nullable
  - `customer_name` string
  - `description` string, nullable — Description of the resource `{name}`

## Response `200`

OK

- object
  - `result` 'success' | 'error' | 'asynchronous', required — Result of the HTTP request
  - `data` 91ac10ffDrive
    - `id` integer, required — Id of the kDrive
    - `name` string, required — Name of the kDrive
    - `size` integer, required — Maximum space (in bytes)
    - `used_size` integer, required — Used space (in bytes)
    - `created_at` integer, nullable, required — Creation timestamp
    - `updated_at` integer, nullable, required — Last update timestamp
    - `in_maintenance` boolean, required — When maintenance is activated
    - `maintenance_reason` 'demo_end' | 'invoice_overdue' | 'not_renew' | 'technical' — Reason of Drive maintenance.<note><strong>demo_end</strong>: The demonstration period of the Drive has come to an end.</note><note><strong>invoice_overdue</strong>: An invoice for this Drive is currently unpaid.</note><note><strong>not_renew</strong>: This Drive has expired and must be renewed.</note>
    - `maintenance_at` integer, nullable, required — When maintenance was activated at
    - `maintenance_types` 91ac10ffMaintenanceType[] — Types of maintenances.<note><strong>asleep</strong>: The Drive is inactive, cannot perform requested operation. An API call will wake it up asynchronously.</note><note><strong>hard_delete</strong>: The Drive and its storage are being hard deleted, cannot perform requested operation.</note><note><strong>manager_in_maintenance</strong>: Drive is in maintenance, cannot perform requested operation.</note><note><strong>manager_is_blocked</strong>: Drive is blocked, cannot perform requested operation.</note><note><strong>move_ns</strong>: The Drive is being moved to another namespace, cannot perform requested operation.</note><note><strong>move_sql_cluster</strong>: The Drive database is being moved, cannot perform requested operation.</note><note><strong>move_sql_master</strong>: The Drive database main instance is being moved, cannot perform requested operation.</note><note><strong>rewind</strong>: A restoration is being applied, cannot perform requested operation.</note><note><strong>uninitializing</strong>: The Drive never had any significant activity so it is being uninitialized, cannot perform requested operation.</note><note><strong>upgrade_schema</strong>: The Drive database is being upgraded, cannot perform requested operation.</note><note><strong>waking_up</strong>: The Drive was inactive but is in the process of waking up, cannot perform requested operation for now.</note>
      - `name` string, required — Name of active Maintenance Type
      - `code` string, required — Active Maintenance Type
      - `description` string, required — Short explanation of active Maintenance Type
    - `version` string, required — Backend version
    - `users_count` integer, required — Number of user slots used
    - `users_quota` integer, required — Maximum number of users for this kdrive
    - `product_id` integer, required — Unique id of the kDrive product
    - `account_id` integer, required — Id of the account in which the kDrive is
    - `account` 91ac10ffAccount
      - `id` integer, required — Unique identifier of the resource `Account`
      - `beta` boolean, required — If the account is a beta version
      - `name` string, required — Name of the resource `Account`
      - `legal_entity_type` 'company' | 'individual' | 'public_body' | 'restrict', required
      - `phone` string — User phone number
      - `support_level` integer, required — Support level of the account
      - `has_2fa_required` boolean, required — If the account requires 2FA
      - `is_sso` boolean, required — If the account has Single Sign-On (SSO)
      - `website` string
      - `created_at` integer, required — Timestamp `Account` was created at
    - `expired_at` integer, nullable, required — Product expiration timestamp
    - `is_locked` boolean, required — If the product is locked
    - `description` string — Custom description of this kDrive
    - `bill_reference` string — Reference used for billing
    - `is_demo` boolean, required — If the product is in free trial period
    - `role` 'admin' | 'external' | 'none' | 'user', required — Role of the current user within this kDrive
    - `account_admin` boolean, required — Whether user is an administrator of the current kDrive account
    - `is_in_app_subscription` boolean, required — Whether this drive has been purchased within an app store
    - `rewind` 91ac10ffRewindV3
      - `id` integer, required — Rewind identifier
      - `status` 'canceled' | 'done' | 'drive_not_ready' | 'expired' | 'failed' | 'in_progress' | 'new' | 'sanitizing' | 'waiting_approval', required — Rewind status.<note><strong>canceled</strong>: Rewind was canceled by the user and deleted.</note><note><strong>done</strong>: Rewind completed successfully.</note><note><strong>drive_not_ready</strong>: Rewind cannot start because the drive was not ready (uploads or actions in progress).</note><note><strong>expired</strong>: Rewind has expired and deleted.</note><note><strong>failed</strong>: Rewind completed with errors.</note><note><strong>in_progress</strong>: Rewind is currently in progress.</note><note><strong>new</strong>: Rewind did not start.</note><note><strong>sanitizing</strong>: Rewind find the activity to sanitize.</note><note><strong>waiting_approval</strong>: Rewind waiting user approval to continue.</note>
      - `mode` 'directory' | 'drive' | 'user', required — Rewind type.<note><strong>directory</strong>: Rewind only a directory.</note><note><strong>drive</strong>: Rewind all the drive.</note><note><strong>user</strong>: Rewind a user's private folder.</note>
      - `archiving` 'all' | 'current' | 'none', nullable, required — Rewind archive mode, all created files between now and the rewind date will be set to trash or to an archive depending on the mode selected.<note><strong>all</strong>: Keep in an archive folder the current or trashed files.</note><note><strong>current</strong>: Keep in an archive folder the current files.</note><note><strong>none</strong>: Don't build an archive, trash all created files.</note>
      - `directory_id` integer, nullable, required — The targeted directory of the rewind <note>Filled only in directory and user mode</note>
      - `directory` 91ac10ffDirectoryV3
        - `id` integer, required — Unique identifier of the resource `Directory V3`
        - `name` string, required — File name
        - `sorted_name` string — Specific sortable name
        - `path` string — Full path of the Directory V3
        - `type` 'dir' | 'file', nullable, required — Type of returned element either a dir (Directory) or file (File)
        - `status` 'locked' | 'ok' | 'trash_inherited' | 'trashed' | 'uploading', required — Current state of Directory V3. The state can be null meaning that the Directory V3 has no specific state.<note><strong>locked</strong>: Directory V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).</note><note><strong>ok</strong>: Directory V3 is available.</note><note><strong>trash_inherited</strong>: Directory V3 is currently in trash because a parent directory was trashed.</note><note><strong>trashed</strong>: Directory V3 is currently in trash and specifically trashed by the user.</note><note><strong>uploading</strong>: Directory V3 is currently being uploaded. The Directory V3 is locked and no action can be done excepting upload actions.</note>
        - `visibility` '' | 'is_in_private_space' | 'is_in_shared_space' | 'is_in_team_space_folder' | 'is_private_space' | 'is_root' | 'is_shared_space' | 'is_team_space' | 'is_team_space_folder', required — Visibility of Directory V3, empty string if no specific visibility. Add additional information about Directory V3 to show different icons or more.<note><strong></strong>: Empty visibility mean no special visibility.</note><note><strong>is_in_private_space</strong>: Is a Directory V3 inside the private directory of the user.</note><note><strong>is_in_shared_space</strong>: Is a Directory V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.</note><note><strong>is_in_team_space_folder</strong>: Is a Directory V3 inside a Common Documents directory.</note><note><strong>is_private_space</strong>: Is the private directory of the user.</note><note><strong>is_root</strong>: Is the root directory of the user.</note><note><strong>is_shared_space</strong>: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user.</note><note><strong>is_team_space</strong>: Is the Common Documents directory, a special directory where the files inside are common to all users by default.</note><note><strong>is_team_space_folder</strong>: Is the root directory inside the Common Documents.</note>
        - `drive_id` integer, required — Drive identifier
        - `depth` integer, required — Current path depth of Directory V3
        - `created_by` integer, nullable, required — The identifier of the user who first uploaded the Directory V3
        - `created_at` integer, nullable, required — Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload
        - `added_at` integer, required — The timestamp (in seconds) at which the Directory V3 has been uploaded for the first time
        - `last_modified_at` integer, required — Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload
        - `last_modified_by` integer, nullable, required — Id of the user who last modified the Directory V3
        - `revised_at` integer, required — The last time the content of the Directory V3 was revised
        - `updated_at` integer, required — The last time the Directory V3 was updated
        - `parent_id` integer, required — Parent directory identifier
        - `deleted_at` integer — Timestamp of deleted resource Directory V3, only visible when the Directory V3 is trashed
        - `deleted_by` integer — User identifier of deleted resource Directory V3, only visible when the Directory V3 is trashed
        - `shared_root_id` integer, nullable — Root Directory identifier, only visible for shared user
        - `parents` 91ac10ffDirectoryV3[] — Get all parents directories
        - `users` integer[] — Array of users identifiers that has access to the Directory V3
        - `teams` integer[] — Array of teams identifiers that has access to the Directory V3
        - `is_favorite` boolean — Is Directory V3 pinned as favorite
        - `activity` object — Activities information about the Directory V3
          - `last_accessed_at` integer, required — Timestamp of the last user access of the Directory V3
        - `sharelink` 91ac10ffShareLink
          - `url` string, required — Share link url
          - `file_id` integer, required
          - `right` 'inherit' | 'password' | 'public', required — Rights required to view the share link.<note><strong>inherit</strong>: Share link is accessible only by users of the drive.</note><note><strong>password</strong>: Share link is public but protected by a password.</note><note><strong>public</strong>: Share link is public, no restriction set.</note>
          - `valid_until` integer, nullable, required — Until when the share link is valid
          - `created_by` integer, required — Unique identifier of the creator of the resource `Share Link`
          - `created_at` integer, nullable, required — Timestamp `Share Link` was created at
          - `updated_at` integer, nullable, required — Timestamp `Share Link` was updated at
          - `capabilities` object, required
            - `can_edit` boolean, required — Does share link allow editing
            - `can_see_stats` boolean, required — Does share link allow stats to be seen
            - `can_see_info` boolean, required — Does share link allow info to be seen
            - `can_download` boolean, required — Does share link allow download
            - `can_comment` boolean, required — Does share link allow adding comments
            - `can_request_access` boolean, required — Does share link allow user to request access to folder
          - `access_blocked` boolean, required — If the share link is blocked
          - `views` integer, nullable — Number of views of share link (last 180 days only)
        - `capabilities` object — Directory rights
          - `can_use_favorite` boolean, required — Right to set file as favorite
          - `can_become_sharelink` boolean, required — Right to share file by link (share_link)
          - `can_use_team` boolean, required — Right to use and give team access
          - `can_show` boolean, required — Right to see Directory V3 information
          - `can_read` boolean, required — Right to read Directory V3 content
          - `can_write` boolean, required — Right to write Directory V3
          - `can_share` boolean, required — Right to share Directory V3 or manage access to Directory V3
          - `can_leave` boolean, required — Right to leave shared Directory V3
          - `can_delete` boolean, required — Right to delete Directory V3
          - `can_rename` boolean, required — Right to rename Directory V3
          - `can_move` boolean, required — Right to move Directory V3
          - `can_create_directory` boolean, required — Right to add new child directory
          - `can_create_file` boolean, required — Right to add new child file
          - `can_upload` boolean, required — Right to upload a child file
          - `can_move_into` boolean, required — right to move directory
          - `can_become_dropbox` boolean, required — Right to use convert directory into collaborative directory
          - `colorable` boolean, required — Right to change or add color to the directory
        - `lock` object — When Directory V3 is locked, locked information
          - `locked_at` integer, nullable, required — When Directory V3 is locked, locked timestamp
          - `unlocked_at` integer, nullable, required — When Directory V3 is locked, automatic lock release timestamp
          - `description` '365' | 'external_import' | 'internal_copy' | 'internal_import' | 'onlyoffice' | 'unknown' | 'webdav', nullable, required — List of applications.<note><strong>365</strong>: The 365 application.</note><note><strong>external_import</strong>: The external_import application.</note><note><strong>internal_copy</strong>: The internal_copy application.</note><note><strong>internal_import</strong>: The internal_import application.</note><note><strong>onlyoffice</strong>: The onlyoffice application.</note><note><strong>webdav</strong>: The webdav application.</note>
          - `token` string, nullable, required — When Directory V3 is locked, locked token
        - `categories` 91ac10ffFileCategory[] — File categories
          - `category_id` integer, required — Category identifier
          - `added_at` integer, required — Time when the category was added to file
          - `user_validation` 'CORRECT' | 'INCORRECT' | 'TO_VALIDATE', nullable, required — State of user validation after auto assignment from AI.
          - `is_generated_by_ai` boolean, required — Whether the Category was generated by an AI or not
          - `user_id` integer, nullable, required — User identifier
          - `category` 91ac10ffCategory
            - `id` integer, required — Category identifier
            - `name` string, required — Category name
            - `color` string, required — Color the Category displays in
            - `is_predefined` boolean, required — If the Category is system or user defined
            - `created_by` integer, required — Unique identifier of the creator of the resource `Category`
            - `created_at` integer, required — Timestamp `Category` was created at
            - `user_uses` integer — Number of uses of the Category
        - `etag` string, nullable — ETag of the file
        - `color` string, nullable, required — Color of the directory for the user requesting it
        - `dropbox` 91ac10ffDropbox
          - `id` integer, required — Unique identifier of the resource `Dropbox`
          - `uuid` string, required — Dropbox unique identifier
          - `name` string, required — Name of the dropbox
          - `url` string, required — Public URL of the dropbox
          - `directory` 91ac10ffDirectoryV3 — recursive
          - `users_count` integer, required — Number of recorded users that uploaded in the dropbox
          - `created_by` integer, required — Unique identifier of the creator of the resource `Dropbox`
          - `created_at` integer, nullable, required — Timestamp `Dropbox` was created at
          - `updated_at` integer, nullable, required — Timestamp `Dropbox` was updated at
          - `last_uploaded_at` integer, nullable, required — Last time someone uploaded a file in the dropbox
          - `capabilities` object, required
            - `has_password` boolean, required — A password was defined to access to the dropbox
            - `has_notification` boolean — Notification was enabled on the dropbox, email we be send to dropbox owner when someone upload a file
            - `has_validity` boolean, required — A validity period was set to the dropbox, after the date define the dropbox is not accessible
            - `has_size_limit` boolean, required — A limit size was defined to the dropbox, after the date define the dropbox is not accessible
            - `validity` string
            - `size` string
          - `user` 91ac10ffAppUser
            - `id` integer, required — Unique identifier of the resource `App User`
            - `display_name` string, required — Display name
            - `first_name` string, required — First name
            - `last_name` string, required — Last name
            - `email` string, required — Email
            - `is_sso` boolean, required — returns true if the user is provided by an external IDP
            - `avatar` string, nullable, required — null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar
            - `type` string
            - `deleted_at` integer, nullable, required — Timestamp `App User` was deleted at
            - `teams` integer[] — List of Team identifiers
            - `security` object
              - …
        - `external_import` 91ac10ffExternalImport
          - `id` integer, required — External import identifier
          - `application` 'dropbox' | 'kdrive' | 'kdrive_sharelink' | 'onedrive', required — Service from which the import originates.<note><strong>dropbox</strong>: Import from Dropbox.</note><note><strong>kdrive</strong>: Import from another kDrive.</note><note><strong>kdrive_sharelink</strong>: Import from a kDrive sharelink.</note><note><strong>onedrive</strong>: Import from Microsoft OneDrive.</note>
          - `account_name` string, required — Account imported
          - `status` 'canceled' | 'canceling' | 'done' | 'failed' | 'in_progress' | 'queued' | 'waiting', required — External import status.<note><strong>canceled</strong>: External import was canceled.</note><note><strong>canceling</strong>: External import is being canceled.</note><note><strong>done</strong>: External import is finished.</note><note><strong>failed</strong>: External import failed.</note><note><strong>in_progress</strong>: External import is currently in progress.</note><note><strong>queued</strong>: External import is waiting for a process to handle it.</note><note><strong>waiting</strong>: External import has not started yet.</note>
          - `error_code` string — Give an error code if the failed reason is known.
          - `path` string, required — Import path destination
          - `directory_id` integer, nullable, required — Import directory identifier destination (if was not deleted)
          - `has_shared_files` string, required — Import application has shared files
          - `created_at` integer, required — Timestamp `External Import` was created at
          - `updated_at` integer, required — Timestamp `External Import` was updated at
          - `count_success_files` integer, required — Number of successfully imported files
          - `count_failed_files` integer, required — Number of failed imported files
        - `rewind` 91ac10ffRewindV3 — recursive
      - `directory_name` string — The name of the directory selected when the directory mode is selected
      - `user_id` integer, nullable, required — The targeted user of the rewind <note>Filled only in user mode</note>
      - `rewind_at` integer, required — Rewind at
      - `created_at` integer, required — created at
      - `finished_at` integer — when the rewind is executed the finished process time is save here
      - `expires_at` integer, required — Date of the rewind approval
      - `created_by` integer, required — created by the user
      - `is_approved` boolean, required — Rewind approved by the user
      - `approval_at` integer, required — Date of the rewind approval
      - `rewind_name` string — The name of the directory choose during approval step
      - `sanitizer` object — Sanitizer resume, returned only when the rewind has done the sanitizing process
        - `sanitized` integer, required
        - `total` object, required
          - `to_execute` integer, required
          - `files_found` integer, required
          - `to_move` integer, required
          - `to_rename` integer, required
          - `to_update` integer, required
          - `to_restore` integer, required
          - `to_trash` integer, required
          - `to_archive` integer, required
          - `not_handled_versions` integer, required
          - `not_handled_files` integer, required
        - `team` object, required
          - `to_execute` integer, required
          - `files_found` integer, required
          - `to_move` integer, required
          - `to_rename` integer, required
          - `to_update` integer, required
          - `to_restore` integer, required
          - `to_trash` integer, required
          - `to_archive` integer, required
          - `not_handled_versions` integer, required
          - `not_handled_files` integer, required
        - `me` object, required
          - `to_execute` integer, required
          - `files_found` integer, required
          - `to_move` integer, required
          - `to_rename` integer, required
          - `to_update` integer, required
          - `to_restore` integer, required
          - `to_trash` integer, required
          - `to_archive` integer, required
          - `not_handled_versions` integer, required
          - `not_handled_files` integer, required
        - `others` string
      - `summary` object — Rewind resume, returned only when the rewind is finished
        - `total` object, required
          - `executed` integer, required
          - `archived` integer, required
          - `conflicted` integer, required
        - `team` object, required
          - `executed` integer, required
          - `archived` integer, required
          - `conflicted` integer, required
          - `directory_id` integer, nullable, required
          - `directory_archive_id` integer, nullable, required
          - `directory_conflict_id` integer, nullable, required
        - `me` object, required
          - `executed` integer, required
          - `archived` integer, required
          - `conflicted` integer, required
          - `directory_id` integer, nullable, required
          - `directory_archive_id` integer, nullable, required
          - `directory_conflict_id` integer, nullable, required
        - `others` 91ac10ffRewindSummaryFileCounter[]
          - `user_id` integer, required — User id
          - `executed` integer, required — Total of actions executed
          - `archived` integer, required — Total of actions archived
          - `conflicted` integer, required — Total of actions conflicted
    - `invitations_count` integer — Number of pending invitation.
    - `categories` 91ac10ffCategory[] — All categories of the kDrive
      - `id` integer, required — Category identifier
      - `name` string, required — Category name
      - `color` string, required — Color the Category displays in
      - `is_predefined` boolean, required — If the Category is system or user defined
      - `created_by` integer, required — Unique identifier of the creator of the resource `Category`
      - `created_at` integer, required — Timestamp `Category` was created at
      - `user_uses` integer — Number of uses of the Category
    - `categories_permissions` 91ac10ffCategorypermission
      - `can_create` boolean, required — User can create new categories
      - `can_edit` boolean, required — User can edit existing categories
      - `can_delete` boolean, required — User can delete categories and remove them from files
      - `can_read_on_file` boolean, required — User can read the categories that are present on files
      - `can_put_on_file` boolean, required — User can add categories to files
    - `users` object — All users identifiers by types
      - `account` integer[] — Users identifiers of the account group
      - `drive` integer[] — Users identifiers of the kDrive
      - `external` integer[] — Users identifiers of the drive (only externals users)
      - `internal` integer[] — Users identifiers of the drive (only internal users)
    - `teams` object — All teams identifiers by types
      - `account` integer[] — Teams identifiers of the account group
      - `drive` integer[] — Teams identifiers of the kDrive
    - `rights` 91ac10ffRight
      - `technical` boolean
      - `statistic` boolean
      - `check` boolean
      - `sale` boolean
    - `tags` 91ac10ffTag[] — User defined tags on this kDrive
      - `id` integer, required — Unique identifier of the resource `Tag`
      - `name` string, required — Name of the resource `Tag`
      - `color` integer, required
      - `product_count` integer — Product count related to the resource `Tag`
    - `k_suite` 91ac10ffKSuite
      - `id` integer, required — Id of the kSuite
      - `name` string, required — Name of the kSuite
      - `pack_id` integer, required — Id of the type of kSuite
      - `pack` string, required — Name of the type of kSuite
    - `capabilities` object — The Drive available features list
      - `use_versioning` boolean, required — Is versioning activated
      - `use_upload_compression` boolean, required — During upload compression is allowed
      - `use_team_space` boolean, required — Shared/Team directory feature
      - `can_add_user` boolean, required — Can add an user in the kDrive
      - `can_see_stats` boolean, required — Can see stats of the kDrive
      - `can_upgrade_to_ksuite` boolean, required — Can the drive be upgraded to a kSuite
      - `can_rewind` boolean, required — Can rewind the kDrive
      - `can_use_rag` boolean, required — Can use RAG AI assistant on document content
      - `search` 'content' | 'indexing' | 'meta' | 'rag', required — Active search capabilities of the kDrive
    - `settings` object — Settings of the current users for this kDrive
      - `ai_scan` object, required
        - `is_enabled` boolean, required — Is AI scanning enabled
        - `has_approved` boolean, nullable, required — Is AI scanning approved
        - `has_approved_ai_categories` boolean, nullable, required — Are AI categories approved
        - `has_approved_content_search` boolean, nullable, required — Is file content search approved
        - `updated_at` integer, nullable, required — When AI scanning was approved at
      - `versioning` object, required
        - `max_numbers` integer, required — Number of versions that can be kept if active
        - `max_days` integer, required — Maximum number of days versions are kept
      - `office` object, required
        - `presentation` '365' | 'collabora' | 'onlyoffice', required — Default current application for presentation document.<note><strong>365</strong>: The 365 application.</note><note><strong>collabora</strong>: The collabora application.</note><note><strong>onlyoffice</strong>: The onlyoffice application.</note>
        - `spreadsheet` '365' | 'collabora' | 'onlyoffice', required — Default current application for spreadsheet document.<note><strong>365</strong>: The 365 application.</note><note><strong>collabora</strong>: The collabora application.</note><note><strong>onlyoffice</strong>: The onlyoffice application.</note>
        - `text` '365' | 'collabora' | 'onlyoffice', required — Default current application for text document.<note><strong>365</strong>: The 365 application.</note><note><strong>collabora</strong>: The collabora application.</note><note><strong>onlyoffice</strong>: The onlyoffice application.</note>
        - `default_mode` 'desktop' | 'embedded' | 'mobile', nullable, required — OnlyOffice display mode.<note><strong>desktop</strong>: Optimized for the display in desktop computer browsers.</note><note><strong>embedded</strong>: Optimized for embedding the documents into a website page.</note><note><strong>mobile</strong>: Optimized for the display in mobile device browsers.</note>
      - `max_keep_deleted_user` string, required — Max time the files of an user deleted is kept
      - `files` object, required
        - `private` object, required
          - `size_threshold` integer, nullable, required — Size quota for private directory. <note>Size in bytes, value is null if no limit has been set on private folders.</note>
      - `report` object, required
        - `storage_report` object, required
          - `frequency` 'monthly' | 'never' | 'semi-monthly' | 'weekly', required — Report frequency.<note><strong>monthly</strong>: Sent every month.</note><note><strong>never</strong>: Never sent.</note><note><strong>semi-monthly</strong>: Sent every two week.</note><note><strong>weekly</strong>: Sent every week.</note>
    - `preferences` object
      - `color` string, required — Default color for kDrive
      - `hide` boolean, required — Is the drive hidden for the current user
      - `default` boolean, required — The default drive chosen by the user, if none the first drive in the list should be considered the default. There should only be one default drive.
      - `default_page` string, required — User's default landing page
      - `ui` object, required — User's UI preferences on current drive
        - `storage_warning_alert` boolean, required — Display an alert when storage limit is about to be reached
        - `storage_limit_alert` boolean, required — Display an alert when storage limit has been reached
        - `rag_ocr_promotion` boolean, required — Display a promotion message about the RAG OCR if the user has not seen it yet
    - `pack` 91ac10ffPricingPlan
      - `id` integer, required — Unique identifier of the resource `Pricing Plan`
      - `name` string, required — Name of the resource `Pricing Plan`
      - `display_name` string, required — Display name
      - `is_free` boolean, required — If the pack is free
      - `limits` object — Get the users and storage limits of the Pricing Plan
        - `users` object, required — Get users number limit of the Pricing Plan
          - `base` integer, required — Included/Allowed number of user
          - `min` integer, nullable, required — Minimum number of additional user
          - `max` integer, nullable, required — Maximum number of additional user
        - `trash` object, required — Get the drive trash options
          - `retention_options` integer[], required — Available options for setting trash retention.<note><strong>one_month</strong>: 30 days.</note><note><strong>one_year</strong>: A year.</note><note><strong>six_months</strong>: 180 days.</note><note><strong>three_months</strong>: 90 days.</note><note><strong>two_months</strong>: 60 days.</note>
        - `storage` object, required — Get the limits of the pricing plan
          - `giga` integer, required — Included/Allowed storage (in gigabyte)
          - `min` integer, nullable, required — Minimum number of additional storage (in gigabyte)
          - `max` integer, nullable, required — Maximum number of additional storage (in gigabyte)
      - `prices` 91ac10ffDrivepackprice[] — Price of the Pricing Plan, contains basic plan and additional storages and users prices by currency
        - `type` 'base' | 'storage_giga' | 'user', required — Drive pack price type, Base: standard price, User : Additional user price, Storage_giga : Additional storage price
        - `unit` integer, required — Unity of additional type
        - `period` integer, required — Price by months
        - `currency_id` integer, required — Currency identifier
        - `amount_excl_vat` number, required — Price without the tax
        - `amount_incl_vat` number, required — Price with the tax
      - `capabilities` object — Locked/Unlocked features of the Pricing Plan
        - `use_vault` boolean, required — Vault directory feature
        - `use_manage_right` boolean, required — Can use additional manage right
        - `use_dropbox` boolean, required — Dropboxes feature
        - `can_rewind` boolean, required — Can access/use restoration feature
        - `use_folder_custom_color` boolean, required — Can set a custom color on a folder
        - `can_access_dashboard` boolean, required — Can access the managing dashboard
        - `can_set_sharelink_password` boolean, required — Public link can be protected by password
        - `can_join_sharelink` boolean, required — Users with Infomaniak account can ask to join drive via public links
        - `can_set_sharelink_expiration` boolean, required — Public link can expire
        - `can_set_sharelink_custom_url` boolean, required — Public link can have custom theme
        - `can_use_content_search` boolean, required — Can activate advanced search functions in file contents
        - `can_use_activity_reports` boolean, required — Can access activity reports
        - `can_use_signatures` boolean, required — Can sign documents
        - `can_use_statistics` boolean, required — Can access statistics
        - `can_edit_pdf` boolean, required — Can edit PDFs
        - `can_use_office365` boolean, required — Can access to the Microsoft 365 editor
        - `can_set_office` boolean, required — Can change office editor or office related settings
        - `start_guide_pdf` boolean, required — Add the start guide PDF to the private folder for new users
        - `can_use_rag` boolean, required — Can ask AI assistant questions about the content of an open document
        - `can_use_webdav` boolean, required — Webdav protocol service
        - `can_use_storage_report` boolean, required — Storage report for admins
        - `can_set_trash_duration` boolean, required — Can set trash retention duration
    - `bdd_storage_host` string, nullable — Bdd storage hostname
    - `status` 'initializing' | 'ok' | 'uninitialized', required — Status of the drive
    - `quota` object — Drive feature limits depending on offer
      - `dropbox` string
      - `shared_link` string

## Other responses

- `403` — Forbidden
- `503` — Service Unavailable

---

[API](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools.md) · [All operations](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infomaniak/api-reference-developer-tools/revisions/667aae28fec6/schema)
