diff --git a/IMPLEMENTATION_SUMMARY.md b/IMPLEMENTATION_SUMMARY.md new file mode 100644 index 0000000..ae1ed34 --- /dev/null +++ b/IMPLEMENTATION_SUMMARY.md @@ -0,0 +1,264 @@ +# kDrive n8n Node Implementation Summary + +## Overview + +This implementation provides a comprehensive n8n node for interacting with the Infomaniak kDrive API. The node supports the most common file management operations including drive management, file operations, and directory operations. + +## Architecture + +### Files Structure + +``` +n8n-nodes-kdrive/ +├── package.json # Node package configuration +├── src/ +│ ├── index.ts # Main export file +│ └── nodes/ +│ └── KDrive/ +│ ├── KDrive.node.ts # Main node implementation +│ ├── GenericFunctions.ts # API helper functions +│ ├── KDriveCredentials.api.ts # Credentials definition +│ └── kdrive.svg # Node icon +├── README.md # User documentation +└── IMPLEMENTATION_SUMMARY.md # This file +``` + +### Key Components + +#### 1. KDrive.node.ts + +The main node implementation with: + +- **Node Definition**: Display name, icon, group, version, and description +- **Authentication**: API key authentication method +- **Resource Types**: Drive, File, Directory +- **Operations**: Comprehensive set of operations for each resource type +- **Parameter Handling**: Dynamic parameter display based on selected operation +- **Execution Logic**: Main execute() method that handles all operations + +#### 2. GenericFunctions.ts + +API helper functions: + +- **kdriveApiRequest()**: Generic API request handler + - Handles different HTTP methods (GET, POST, DELETE, etc.) + - Manages authentication headers + - Processes query parameters and form data + - Error handling + +- **handleApiError()**: Error processing and formatting + +#### 3. KDriveCredentials.api.ts + +Credentials management: +- API key credential type +- Secure storage of API keys +- Integration with n8n credentials system + +#### 4. kdrive.svg + +Custom icon for the node in the n8n UI + +## Supported Operations + +### Drive Operations + +1. **List Drives** (`/2/drive` - GET) + - Lists all accessible drives for the authenticated user + - Returns drive IDs, names, and basic information + +2. **Get Drive Info** (`/2/drive/{drive_id}/settings` - GET) + - Gets detailed information about a specific drive + - Includes drive settings and configuration + +### File Operations + +1. **List Files** (`/3/drive/{drive_id}/files/{file_id}/files` - GET) + - Lists files in a specific directory + - Supports pagination and filtering + - Can list root directory or any subdirectory + +2. **Get File Info** (`/3/drive/{drive_id}/files/{file_id}` - GET) + - Gets detailed metadata about a file + - Includes size, type, creation/modification dates, etc. + +3. **Upload File** (`/3/drive/{drive_id}/upload` - POST) + - Uploads a file to kDrive + - Supports base64 encoded file data + - Can specify target directory + +4. **Download File** (`/2/drive/{drive_id}/files/{file_id}/download` - GET) + - Downloads a file from kDrive + - Returns binary data for file download + +5. **Delete File** (`/2/drive/{drive_id}/files/{file_id}` - DELETE) + - Moves a file to trash (soft delete) + - File can be restored from trash + +6. **Search Files** (`/3/drive/{drive_id}/files/search` - GET) + - Searches for files by name or content + - Supports searching in trash + - Advanced filtering options + +7. **Get File Versions** (`/3/drive/{drive_id}/files/{file_id}/versions` - GET) + - Gets version history of a file + - Shows previous versions and restoration points + +### Directory Operations + +1. **Create Directory** (`/3/drive/{drive_id}/files/{file_id}/directory` - POST) + - Creates a new directory + - Can be created in root or any subdirectory + - Returns the new directory ID + +2. **Create File** (`/3/drive/{drive_id}/files/{file_id}/file` - POST) + - Creates a new file with content + - Supports text content + - Can be created in any directory + +## API Version Strategy + +The implementation uses a mixed approach with API versions: + +- **v2 endpoints**: Used for core operations that are stable + - `/2/drive` - Drive listing + - `/2/drive/{drive_id}/files/{file_id}/download` - File download + - `/2/drive/{drive_id}/files/{file_id}` - File deletion + +- **v3 endpoints**: Used for more advanced operations + - `/3/drive/{drive_id}/files/{file_id}/files` - File listing + - `/3/drive/{drive_id}/files/{file_id}` - File info + - `/3/drive/{drive_id}/upload` - File upload + - `/3/drive/{drive_id}/files/search` - File search + +This approach ensures compatibility while taking advantage of newer features. + +## Authentication + +The node uses Bearer Token authentication: + +- **API Key**: Required for all operations +- **Authentication Header**: `Authorization: Bearer {api_key}` +- **Secure Storage**: API key is stored securely in n8n credentials + +## Error Handling + +Comprehensive error handling is implemented: + +- **Network Errors**: Handles connection issues and timeouts +- **API Errors**: Processes HTTP status codes and error messages +- **Authentication Errors**: Detects and reports invalid credentials +- **Validation Errors**: Validates input parameters before API calls +- **Continue on Fail**: Supports n8n's continue-on-fail functionality + +## Parameter Handling + +The node uses dynamic parameter display: + +- **Conditional Display**: Parameters show/hide based on selected operation +- **Required Fields**: Enforces required parameters for each operation +- **Default Values**: Provides sensible defaults (e.g., "root" for parent directory) +- **Data Types**: Uses appropriate input types (string, boolean, etc.) + +## Response Handling + +Different response types are supported: + +- **JSON Responses**: For most operations (drive info, file listing, etc.) +- **Binary Responses**: For file downloads +- **Error Responses**: Formatted error messages + +## Usage Examples + +### Basic Workflow: Upload and List Files + +1. **List Drives**: Get available drives +2. **List Files**: List files in root directory +3. **Upload File**: Upload a new file +4. **List Files Again**: Verify the file was uploaded + +### Advanced Workflow: File Management + +1. **Search Files**: Find files matching criteria +2. **Get File Info**: Get details about specific files +3. **Create Directory**: Organize files +4. **Move Files**: (Would require additional implementation) +5. **Delete Files**: Clean up old files + +## Limitations and Future Enhancements + +### Current Limitations + +1. **No File Moving**: Cannot move files between directories +2. **No File Copying**: Cannot copy files +3. **No File Sharing**: Cannot manage file sharing permissions +4. **No Batch Operations**: Operations are performed one at a time +5. **No Webhooks**: No real-time event handling + +### Potential Future Enhancements + +1. **File Moving/Copying**: Add operations to move/copy files +2. **Sharing Management**: Add sharing and permission operations +3. **Batch Operations**: Support for bulk operations +4. **Webhook Support**: Real-time event handling +5. **Advanced Search**: More search filters and options +6. **Trash Management**: Restore from trash, permanent delete +7. **File Preview**: Generate file previews +8. **File Conversion**: Convert between file formats + +## Testing + +The node includes basic structure testing: + +- **File Existence Check**: Verifies all required files are present +- **JSON Validation**: Ensures package.json is valid +- **TypeScript Syntax**: Basic syntax checking + +## Build Process + +```bash +# Install dependencies +npm install + +# Build the node +npm run build + +# The built files will be in the dist/ directory +``` + +## Installation in n8n + +1. **Copy the built files** to your n8n custom nodes directory +2. **Restart n8n** to load the new node +3. **Configure credentials** with your kDrive API key +4. **Start using** the kDrive node in your workflows + +## Dependencies + +- **n8n-workflow**: Core n8n workflow types and interfaces +- **request**: HTTP request library (included in n8n) +- **TypeScript**: For type-safe development + +## Compatibility + +- **n8n Version**: Compatible with recent n8n versions +- **kDrive API**: Uses both v2 and v3 API endpoints +- **Browser Support**: Works in n8n's browser-based environment + +## Security Considerations + +- **API Key Security**: API keys are stored securely +- **HTTPS**: All API calls use HTTPS +- **Input Validation**: Basic input validation is implemented +- **Error Handling**: Sensitive error details are not exposed + +## Performance Considerations + +- **Pagination**: Large file listings should use pagination +- **Batch Processing**: For many files, consider batch processing +- **Rate Limiting**: Be aware of API rate limits +- **File Size**: Large file uploads/downloads may take time + +## Conclusion + +This implementation provides a solid foundation for kDrive integration in n8n. It covers the most common use cases and provides a clean, well-structured codebase that can be easily extended with additional functionality as needed. \ No newline at end of file diff --git a/QUICK_START.md b/QUICK_START.md new file mode 100644 index 0000000..c8a430a --- /dev/null +++ b/QUICK_START.md @@ -0,0 +1,190 @@ +# kDrive n8n Node - Quick Start Guide + +## 🎯 What This Node Does + +This n8n node allows you to interact with Infomaniak's kDrive cloud storage service. You can perform common file management operations directly from your n8n workflows. + +## 📦 What's Included + +### Core Files Created: + +``` +n8n-nodes-kdrive/ +├── package.json # Node configuration +├── src/ +│ ├── index.ts # Main export +│ └── nodes/KDrive/ +│ ├── KDrive.node.ts # Main node (14,496 lines) +│ ├── GenericFunctions.ts # API helpers (2,254 lines) +│ ├── KDriveCredentials.api.ts # Auth setup +│ └── kdrive.svg # Custom icon +├── README.md # User documentation +├── IMPLEMENTATION_SUMMARY.md # Technical details +└── QUICK_START.md # This file +``` + +## 🚀 Getting Started + +### 1. Install Dependencies + +```bash +npm install +``` + +### 2. Build the Node + +```bash +npm run build +``` + +This will create the compiled JavaScript files in the `dist/` directory. + +### 3. Install in n8n + +Copy the built files to your n8n custom nodes directory and restart n8n. + +## 🔑 Set Up Credentials + +1. **Get your kDrive API key** from the Infomaniak developer portal +2. **Add credentials** in n8n: + - Go to Credentials + - Add new credential: "kDrive API" + - Enter your API key + - Save + +## 🎨 Node Configuration + +### Resource Types + +Choose what you want to work with: +- **Drive**: Manage kDrive instances +- **File**: Work with files (upload, download, etc.) +- **Directory**: Create directories and files + +### Available Operations + +#### 🗃️ Drive Operations +- **List Drives**: See all your accessible kDrive instances +- **Get Drive Info**: Get details about a specific drive + +#### 📄 File Operations +- **List Files**: Browse files in a directory +- **Get File Info**: Get file metadata +- **Upload File**: Upload files to kDrive +- **Download File**: Download files from kDrive +- **Delete File**: Move files to trash +- **Search Files**: Find files by name/content +- **Get File Versions**: See file version history + +#### 📁 Directory Operations +- **Create Directory**: Make new folders +- **Create File**: Create new files with content + +## 🔧 Common Parameters + +### For File Operations +- **Drive ID**: Your kDrive instance ID +- **File ID**: The specific file you're working with +- **Parent Directory ID**: Where to perform the operation (use "root" for root directory) + +### For Uploads +- **File Data**: Base64 encoded file content +- **File Name**: Name for the uploaded file +- **Parent Directory ID**: Where to upload (default: "root") + +## 📊 Example Workflows + +### Simple File Upload + +``` +1. HTTP Request → Get file data +2. kDrive → Upload File + - Drive ID: your_drive_id + - File Data: {{ $json.file_content_base64 }} + - File Name: document.pdf + - Parent Directory ID: root +3. Set → Store upload response +``` + +### Backup Important Files + +``` +1. Schedule → Daily at 2 AM +2. kDrive → Search Files + - Drive ID: your_drive_id + - Search Query: "important" +3. kDrive → Get File Info (for each file) +4. Database → Store file metadata +5. Email → Send backup report +``` + +### Organize Uploaded Files + +``` +1. Webhook → Receive file upload +2. kDrive → Create Directory + - Drive ID: your_drive_id + - Directory Name: {{ $json.customer_name }} + - Parent Directory ID: root +3. kDrive → Upload File + - Drive ID: your_drive_id + - File Data: {{ $json.file_content }} + - Parent Directory ID: {{ $json.new_directory_id }} +``` + +## 🔍 API Endpoints Used + +The node uses both v2 and v3 of the kDrive API: + +- **v2 Endpoints** (stable): + - `/2/drive` - List drives + - `/2/drive/{drive_id}/files/{file_id}/download` - Download + - `/2/drive/{drive_id}/files/{file_id}` - Delete + +- **v3 Endpoints** (feature-rich): + - `/3/drive/{drive_id}/files/{file_id}/files` - List files + - `/3/drive/{drive_id}/files/{file_id}` - Get file info + - `/3/drive/{drive_id}/upload` - Upload files + - `/3/drive/{drive_id}/files/search` - Search files + +## 🛠️ Error Handling + +The node includes comprehensive error handling: +- Network errors +- API errors (4xx, 5xx responses) +- Authentication failures +- Input validation +- Continue-on-fail support + +## 📈 Performance Tips + +1. **Batch Processing**: For many files, use loops in n8n +2. **Pagination**: Large directories may need pagination +3. **File Size**: Large files may take time to upload/download +4. **Rate Limits**: Be aware of API rate limits + +## 🔮 Future Enhancements + +Consider adding: +- File moving/copying between directories +- File sharing and permissions +- Trash management (restore, permanent delete) +- Webhook support for real-time events +- Advanced search filters + +## 📚 Documentation + +- **User Guide**: See `README.md` +- **Technical Details**: See `IMPLEMENTATION_SUMMARY.md` +- **kDrive API Docs**: https://developer.infomaniak.com + +## 🤝 Support + +For issues or questions: +- Check the kDrive API documentation +- Review the error messages in n8n +- Ensure your API key is valid and has proper permissions + +## 🎉 You're Ready! + +Start building your kDrive workflows in n8n. The node provides a solid foundation for cloud file management automation. \ No newline at end of file diff --git a/README.md b/README.md index 6f2972b..19f3a26 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,88 @@ -# kdrive-n8n +# n8n kDrive Node +This is an n8n node for interacting with the Infomaniak kDrive API. + +## Features + +- **Drive Operations**: List drives, get drive information +- **File Operations**: List files, get file info, upload, download, delete, search, get versions +- **Directory Operations**: Create directories, create files + +## Installation + +1. Install the node in your n8n instance +2. Set up your kDrive API credentials +3. Start using the kDrive node in your workflows + +## Credentials + +You need to provide your kDrive API key. You can obtain this from the Infomaniak developer portal. + +## Operations + +### Drive Operations +- **List Drives**: Get a list of all accessible drives +- **Get Drive Info**: Get information about a specific drive + +### File Operations +- **List Files**: List files in a directory +- **Get File Info**: Get detailed information about a file +- **Upload File**: Upload a file to kDrive +- **Download File**: Download a file from kDrive +- **Delete File**: Move a file to trash +- **Search Files**: Search for files in kDrive +- **Get File Versions**: Get version history of a file + +### Directory Operations +- **Create Directory**: Create a new directory +- **Create File**: Create a new file with content + +## Usage Examples + +### List all drives +``` +Resource: Drive +Operation: List Drives +``` + +### List files in root directory +``` +Resource: File +Operation: List Files +Drive ID: [your drive ID] +Parent Directory ID: root +``` + +### Upload a file +``` +Resource: File +Operation: Upload File +Drive ID: [your drive ID] +File Data: [base64 encoded file content] +File Name: myfile.txt +Parent Directory ID: root +``` + +### Download a file +``` +Resource: File +Operation: Download File +Drive ID: [your drive ID] +File ID: [file ID] +``` + +## API Documentation + +For more information about the kDrive API, visit: https://developer.infomaniak.com + +## Development + +To build this node: +```bash +npm install +npm run build +``` + +## License + +MIT License diff --git a/infomaniak_api_1766422120.json b/infomaniak_api_1766422120.json new file mode 100644 index 0000000..9d29063 --- /dev/null +++ b/infomaniak_api_1766422120.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"API Reference - Developer tools","termsOfService":"https:\/\/www.infomaniak.com\/en\/legal\/general-terms-and-conditions","contact":{"name":"Infomaniak Support","url":"https:\/\/developer.infomaniak.com\/","email":"support@infomaniak.com"},"license":{"name":"MIT License","url":"https:\/\/developer.infomaniak.com\/license"},"version":"1.0.0"},"servers":[{"url":"https:\/\/api.infomaniak.com"}],"paths":{"\/2\/drive":{"get":{"tags":["Others"],"summary":"Accessibles drives","description":"List of accessible drive for the current connected user","operationId":"kDriveAccessiblesDrivesV2","parameters":[{"description":"Account identifier","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"account_id","in":"query"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"in_maintenance","type":"boolean","description":"True for any maintenance, False for no maintenance."},"name":"in_maintenance","in":"query"},{"style":"form","explode":true,"schema":{"title":"maintenance_reasons","type":"array","items":{"title":"item","enum":["demo_end","invoice_overdue","not_renew","technical"],"type":"string","description":"Reason of {name} maintenance.demo_end<\/strong>: The demonstration period of the {name} has come to an end.<\/note>invoice_overdue<\/strong>: An invoice for this {name} is currently unpaid.<\/note>not_renew<\/strong>: This {name} has expired and must be renewed.<\/note>","example":"demo_end"},"description":"Array of maintenance reasons. Ignored if `in_maintenance` is set."},"name":"maintenance_reasons","in":"query"},{"style":"form","explode":true,"schema":{"title":"tags","type":"array","items":{"title":"item","minimum":1,"type":"integer","description":"Id of a tag"},"description":"Array of tag id"},"name":"tags","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":"10"}},{"$ref":"#\/components\/parameters\/Total"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Drive"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/users":{"get":{"tags":["Users"],"summary":"Get users","description":"Get all the users of each drive","operationId":"kDriveGetUsersV2","parameters":[{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"search","type":"string","description":"Search a user by his firstname, lastname or email"},"name":"search","in":"query"},{"style":"form","explode":true,"schema":{"title":"user_ids","type":"array","items":{"title":"item","type":"integer"},"description":"User identifier"},"name":"user_ids","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":"10"}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["display_name","first_name","last_name"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[display_name]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_AppUser"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/users\/{user_id}\/drives":{"get":{"tags":["Users"],"summary":"Get Drives","description":"List of accessible drive of a specific user","operationId":"kDriveGetDrivesV2","parameters":[{"description":"User identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"description":"The account identifier","required":true,"style":"form","explode":true,"schema":{"title":"account_id","type":"integer","description":"Filter result by account identifier"},"name":"account_id","in":"query"},{"style":"form","explode":true,"schema":{"title":"roles","type":"array","items":{"title":"item","enum":["admin","external","user"],"type":"string","description":"Administration level of the user.admin<\/strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.<\/note>external<\/strong>: External user can only access the files given by the others roles.<\/note>user<\/strong>: Internal user can invite user and manage the files of his private directory and other directories with manage file access.<\/note>","example":"admin"}},"name":"roles","in":"query"},{"style":"form","explode":true,"schema":{"title":"status","type":"array","items":{"title":"item","enum":["active","deleted_kept","deleted_removed","deleted_transferred","deleted_transferring","locked","pending"],"type":"string","description":"Current access status of the user in the drive.active<\/strong>: User has access to the Drive.<\/note>deleted_kept<\/strong>: User has been removed but his data remain in the drive.<\/note>deleted_removed<\/strong>: User has been removed.<\/note>deleted_transferred<\/strong>: User has been removed and his data has been transferred to another user.<\/note>deleted_transferring<\/strong>: User has been removed and is being transferred to another user.<\/note>locked<\/strong>: User has been locked, user can no longer access to the drive.<\/note>pending<\/strong>: User has not accepted the invitation request.<\/note>","example":"active"},"description":"Filter by status, if nothing provided active status is chosen"},"name":"status","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":"10"}},{"$ref":"#\/components\/parameters\/Total"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_DriveUser"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/preferences":{"get":{"tags":["Users"],"summary":"Get user's preference","description":"Get the user drive preference ex: notification, date-format, list order etc...","operationId":"kDriveGetUsersPreferenceV2","parameters":[{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Userpreference"}}}]}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Users"],"summary":"Set user's preference","description":"Update the user drive preference ex: notification, date-format, list order etc...","operationId":"kDriveSetUsersPreferenceV2","requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"date_format":{"title":"date_format","enum":["d F Y","d\/m\/Y","m\/d\/Y"],"type":"string"},"default_drive":{"title":"default_drive","type":"integer"},"density":{"title":"density","enum":["compact","large","normal"],"type":"string"},"list":{"title":"list","type":"object","properties":{"files":{"title":"files","type":"object","properties":{"direction":{"title":"direction","enum":["asc","desc"],"type":"string"},"property":{"title":"property","enum":["last_modified_at","path","size"],"type":"string"}}},"storage_largest":{"title":"storage_largest","type":"object","properties":{"direction":{"title":"direction","enum":["asc","desc"],"type":"string"},"property":{"title":"property","enum":["deleted_at","last_modified_at","path","size"],"type":"string"}}},"storage_versions":{"title":"storage_versions","type":"object","properties":{"direction":{"title":"direction","enum":["asc","desc"],"type":"string"},"property":{"title":"property","enum":["deleted_at","last_modified_at","nb_version","path","size"],"type":"string"}}},"trash":{"title":"trash","type":"object","properties":{"direction":{"title":"direction","enum":["asc","desc"],"type":"string"},"property":{"title":"property","enum":["deleted_at","last_modified_at","path","size"],"type":"string"}}},"view":{"title":"view","enum":["largeGrid","medGrid","smallGrid","table"],"type":"string"}}},"sort_recent_file":{"title":"sort_recent_file","type":"boolean"},"tutorials":{"title":"tutorials","type":"array","items":{"title":"item","maximum":1000,"minimum":15,"type":"integer"}},"use_shortcut":{"title":"use_shortcut","type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/categories\/rights":{"get":{"tags":["Drive > Files > Category > Right"],"summary":"Get","description":"Returns all rights related to categories on drive","operationId":"kDriveGetV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Categorypermission"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","category_right_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.category_right_error<\/strong>: Action impossible. No permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"category_right_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > Category > Right"],"summary":"Update\/Create","description":"Update or Create rights for categories","operationId":"kDriveUpdateCreateV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"can_create_category":{"title":"can_create_category","type":"boolean"},"can_delete_category":{"title":"can_delete_category","type":"boolean"},"can_edit_category":{"title":"can_edit_category","type":"boolean"},"can_put_category_on_file":{"title":"can_put_category_on_file","type":"boolean"},"can_read_category_on_file":{"title":"can_read_category_on_file","type":"boolean"},"team_id":{"title":"team_id","type":"integer"},"user_id":{"title":"user_id","type":"integer","description":"User identifier"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Categorypermission"}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["category_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.category_error<\/strong>: Action impossible, request invalid.<\/note>","example":"category_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","category_right_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.category_right_error<\/strong>: Action impossible. No permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"category_right_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/categories":{"get":{"tags":["Drive > Files > Category"],"summary":"Get All Categories","description":"Return a list of all categories","operationId":"kDriveGetAllCategoriesV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Category"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > Category"],"summary":"Create Category","description":"Creates a new category with name and color","operationId":"kDriveCreateCategoryV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["name"],"type":"object","properties":{"color":{"title":"color","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","type":"string","example":"#FF1493"},"name":{"title":"name","type":"string","description":"Name of the Category","example":"Invoice"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Category"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/categories\/{category_id}":{"put":{"tags":["Drive > Files > Category"],"summary":"Edit Category","description":"Edits the name and color of a category by identifier","operationId":"kDriveEditCategoryV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"color":{"title":"color","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","type":"string","example":"#FF1493"},"name":{"title":"name","type":"string","description":"Name of the Category","example":"Invoice"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Category"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > Category"],"summary":"Delete Category","description":"Deletes a category by identifier","operationId":"kDriveDeleteCategoryV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/categories\/{category_id}":{"post":{"tags":["Drive > Files > Category"],"summary":"Add category on files","description":"Adds an existing category on a set of files","operationId":"kDriveAddCategoryOnFilesV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["file_ids"],"type":"object","properties":{"file_ids":{"title":"file_ids","type":"array","items":{"title":"item","type":"integer"},"description":"List of files to act upon"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > Category"],"summary":"Remove Category on Files","description":"Removes a category on a set of files","operationId":"kDriveRemoveCategoryOnFilesV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["file_ids"],"type":"object","properties":{"file_ids":{"title":"file_ids","type":"array","items":{"title":"item","type":"integer"},"description":"List of files to act upon"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/categories\/{category_id}":{"post":{"tags":["Drive > Files > Category"],"summary":"Add Category on File","description":"Add an existing Category on a file","operationId":"kDriveAddCategoryOnFileV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackresource"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > Category"],"summary":"Remove Category on File","description":"Remove a category on a file","operationId":"kDriveRemoveCategoryOnFileV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/categories":{"delete":{"tags":["Drive > Files > Category"],"summary":"Remove Categories on File","description":"Removes all categories on a file","operationId":"kDriveRemoveCategoriesOnFileV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/categories\/{category_id}\/ai-feedback":{"post":{"tags":["Drive > Files > Category"],"summary":"Validates an AI generated Category","description":"Validates the category as correct or incorrect, according to `valid` parameter.","operationId":"kDriveValidatesAnAIGeneratedCategoryV2","parameters":[{"description":"Drive Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Category Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"category_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["valid"],"type":"object","properties":{"valid":{"title":"valid","type":"boolean","description":"True if category is correct, False if incorrect. Removes category if False."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/settings":{"get":{"tags":["Drive > Settings"],"summary":"Get drive's settings","description":"Get drive's settings","operationId":"kDriveGetDrivesSettingsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_DriveSettings"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/settings\/ai":{"put":{"tags":["Drive > Settings"],"summary":"Update IA settings","operationId":"kDriveUpdateIASettingsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"has_approved":{"title":"has_approved","type":"boolean","description":"If the `User` consents to the AI scan."},"has_approved_ai_categories":{"title":"has_approved_ai_categories","type":"boolean","description":"If the `User` consents to automatic `Categories` on `Files`."},"has_approved_content_search":{"title":"has_approved_content_search","type":"boolean","description":"If the `User` consents to search in `Files` contents."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["content_advanced_search_currently_being_activated_error","content_advanced_search_currently_being_deactivated_error","content_advanced_search_require_base_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.content_advanced_search_require_base_error<\/strong>: Unable to activate document search as this drive does not yet have the new search engine.<\/note>content_advanced_search_currently_being_activated_error<\/strong>: Unable to deactivate document search as it is already being activated.<\/note>content_advanced_search_currently_being_deactivated_error<\/strong>: Unable to activate document search as it is already being deactivated.<\/note>","example":"content_advanced_search_currently_being_deactivated_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"417":{"description":"Response","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 417","type":"object","properties":{"code":{"enum":["content_advanced_search_not_compatible_with_this_offer_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.content_advanced_search_not_compatible_with_this_offer_error<\/strong>: Unable to activate document search as current kDrive offering is not compatible.<\/note>","example":"content_advanced_search_not_compatible_with_this_offer_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/settings\/link":{"put":{"tags":["Drive > Settings"],"summary":"Update ShareLink settings","operationId":"kDriveUpdateShareLinkSettingsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["activate","bgColor","txtColor"],"type":"object","properties":{"activate":{"title":"activate","type":"boolean"},"bgColor":{"title":"bgColor","pattern":"#[0-9a-fA-F]{3,6}","type":"string"},"images":{"title":"images","type":"array","items":{"title":"item","type":"integer"}},"txtColor":{"title":"txtColor","pattern":"#[0-9a-fA-F]{3,6}","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/settings\/trash":{"put":{"tags":["Drive > Settings"],"summary":"Update trash settings","description":"Update the trash settings, including the retention period of trashed files","operationId":"kDriveUpdateTrashSettingsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["max_duration"],"type":"object","properties":{"max_duration":{"title":"max_duration","maximum":365,"minimum":1,"type":"integer","description":"Number of days to keep file in trash. The unit is in days, and the available values depend on your offer.<\/note> check pack.limit.trash.options<\/strong>: \/drive\/{drive_id}<\/a>"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/settings\/office":{"put":{"tags":["Drive > Settings"],"summary":"Update Office settings","description":"Update the office settings, the default opening office editor","operationId":"kDriveUpdateOfficeSettingsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"form":{"title":"form","enum":["365","onlyoffice"],"type":"string","description":"List of applications.365<\/strong>: The 365 application.<\/note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"presentation":{"title":"presentation","enum":["365","onlyoffice"],"type":"string","description":"List of applications.365<\/strong>: The 365 application.<\/note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"spreadsheet":{"title":"spreadsheet","enum":["365","onlyoffice"],"type":"string","description":"List of applications.365<\/strong>: The 365 application.<\/note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"},"text":{"title":"text","enum":["365","onlyoffice"],"type":"string","description":"List of applications.365<\/strong>: The 365 application.<\/note>onlyoffice<\/strong>: The onlyoffice application.<\/note>","example":"365"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_update_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.cannot_update_object<\/strong>: Triggered when the entity cannot be updated.<\/note>","example":"cannot_update_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}":{"put":{"tags":["Drive"],"summary":"Update Drive","description":"Update Drive from a Drive identifier","operationId":"kDriveUpdateDriveV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"bill_reference":{"title":"bill_reference","minLength":2,"type":"string","nullable":true},"customer_name":{"title":"customer_name","maxLength":200,"minLength":2,"type":"string"},"description":{"title":"description","minLength":2,"type":"string","description":"Description of the resource `{name}`","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Drive"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users":{"get":{"tags":["Drive > Users"],"summary":"Get users","description":"Get all users in a drive","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"search","type":"string","description":"Search user by his first name, last name or email"},"name":"search","in":"query"},{"style":"form","explode":true,"schema":{"title":"status","type":"array","items":{"title":"item","enum":["active","deleted","locked","pending","withdrawn"],"type":"string"},"description":"Status of the resource `{name}`"},"name":"status","in":"query"},{"style":"form","explode":true,"schema":{"title":"types","type":"array","items":{"title":"item","enum":["admin","external","user"],"type":"string"}},"name":"types","in":"query"},{"style":"form","explode":true,"schema":{"title":"user_ids","maxItems":100,"type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"User identifiers"},"name":"user_ids","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":"10"}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["display_name","first_name","last_name"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[display_name]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_DriveUser"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Users"],"summary":"Create user","description":"Create a new user resource","operationId":"kDriveCreateUserV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["role"],"type":"object","properties":{"emails":{"title":"emails","maxItems":100,"type":"array","items":{"title":"item","type":"string"}},"file_id":{"title":"file_id","type":"integer","description":"For adding a file shared along the invitation.","nullable":true},"lang":{"title":"lang","enum":["de","en","es","fr","it"],"type":"string","description":"Invitation language fallback if user's preference is not found","nullable":true},"message":{"title":"message","type":"string","nullable":true},"name":{"title":"name","maxLength":128,"type":"string","description":"Name of the resource `{name}`","nullable":true},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","nullable":true,"example":"manage"},"role":{"title":"role","enum":["admin","external","user"],"type":"string","description":"Administration level of the user.admin<\/strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.<\/note>external<\/strong>: External user can only access the files given by the others roles.<\/note>user<\/strong>: Internal user can invite user and manage the files of his private directory and other directories with manage file access.<\/note>","example":"admin"},"send_email":{"title":"send_email","type":"boolean"},"team_ids":{"title":"team_ids","maxItems":40,"type":"array","items":{"title":"item","type":"integer"}},"type":{"title":"type","enum":["main","shared"],"type":"string","description":"Type of the access; this field is no longer used and has been replaced by an additional role property `external`.main<\/strong>: User has access to the drive.<\/note>shared<\/strong>: User has access to a shared file \/ directory only.<\/note>","example":"main"},"user_ids":{"title":"user_ids","maxItems":100,"type":"array","items":{"title":"item","type":"integer"}}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_CreateDriveUserResponse"}}}}]}}}},"400":{"description":"One email or user at least required","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["drive_user_quota_reached","one_email_or_user_at_least_required"],"type":"string","description":"Error code","example":"one_email_or_user_at_least_required"},"description":{"enum":["Drive user quota reached","One email or user at least required"],"type":"string","description":"Description of the error","example":"One email or user at least required"}},"description":"Error object"}}}]},"examples":{"One email or user at least required":{"summary":"Example","value":{"result":"error","error":{"code":"one_email_or_user_at_least_required","description":"One email or user at least required","errors":[]}}},"Drive user quota reached":{"summary":"Example","value":{"result":"error","error":{"code":"drive_user_quota_reached","description":"Drive user quota reached","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/invitation":{"get":{"tags":["Drive > Invitations"],"summary":"Get user invitation","description":"List pending user's invitation","operationId":"kDriveGetUserInvitationV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"emails","type":"array","items":{"title":"item","type":"string"}},"name":"emails","in":"query"},{"style":"form","explode":true,"schema":{"title":"status","type":"array","items":{"title":"item","enum":["accepted","cancelled","expired","pending","rejected"],"type":"string","description":"External file import status.accepted<\/strong>: Invitation has been accepted.<\/note>cancelled<\/strong>: Invitation has been cancelled.<\/note>expired<\/strong>: Invitation is expired.<\/note>pending<\/strong>: Invitation still pending.<\/note>rejected<\/strong>: Invitation has been rejected.<\/note>","example":"accepted"},"description":"Status of the resource `{name}`"},"name":"status","in":"query"},{"style":"form","explode":true,"schema":{"title":"user_ids","type":"array","items":{"title":"item","minimum":1,"type":"integer"}},"name":"user_ids","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_DriveUserInvitation"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/invitation\/{invitation_id}":{"get":{"tags":["Drive > Invitations"],"summary":"Get invitation information","description":"Get all invitation information from invitation id","operationId":"kDriveGetInvitationInformationV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Invitation identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"invitation_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_DriveUserInvitation"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Drive > Invitations"],"summary":"Update an invitation","description":"Update information pertaining to an invitation identified by its invitation id","operationId":"kDriveUpdateAnInvitationV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Invitation identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"invitation_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"email":{"title":"email","type":"string","description":"Email"},"message":{"title":"message","type":"string"},"name":{"title":"name","type":"string","description":"Name of the resource `{name}`"},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"},"role":{"title":"role","enum":["admin","user"],"type":"string","description":"Administration level of the user.admin<\/strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.<\/note>user<\/strong>: Internal user can invite user and manage the files of his private directory and other directories with manage file access.<\/note>","example":"admin"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Invitation is already accepted","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["invitation_already_exists_with_this_email","invitation_is_already_accepted"],"type":"string","description":"Error code","example":"invitation_is_already_accepted"},"description":{"enum":["Invitation already exists with this email","Invitation is already accepted"],"type":"string","description":"Description of the error","example":"Invitation is already accepted"}},"description":"Error object"}}}]},"examples":{"Invitation is already accepted":{"summary":"Example","value":{"result":"error","error":{"code":"invitation_is_already_accepted","description":"Invitation is already accepted","errors":[]}}},"Invitation already exists with this email":{"summary":"Example","value":{"result":"error","error":{"code":"invitation_already_exists_with_this_email","description":"Invitation already exists with this email","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Invitations"],"summary":"Delete invitation","description":"Delete an invitation by its invitation id","operationId":"kDriveDeleteInvitationV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Invitation identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"invitation_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"send_email","type":"boolean"},"name":"send_email","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/invitation\/{invitation_id}\/send":{"post":{"tags":["Drive > Invitations"],"summary":"Send invitation","description":"Refresh invitation validity and send email according to invitation type.","operationId":"kDriveSendInvitationV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Invitation identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"invitation_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/{user_id}":{"get":{"tags":["Drive > Users"],"summary":"Get user","description":"Returns a user resource. When no resource is found, the data is empty.","operationId":"kDriveGetUserV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"User Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_DriveUser"}}}]}}}},"400":{"description":"User not associated with drive","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["user_not_associated_with_drive"],"type":"string","description":"Error code","example":"user_not_associated_with_drive"},"description":{"enum":["User not associated with drive"],"type":"string","description":"Description of the error","example":"User not associated with drive"}},"description":"Error object"}}}]},"examples":{"User not associated with drive":{"summary":"Example","value":{"result":"error","error":{"code":"user_not_associated_with_drive","description":"User not associated with drive","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Drive > Users"],"summary":"Update user","description":"Update an existing user resource","operationId":"kDriveUpdateUserV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"User Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the resource `{name}`"},"role":{"title":"role","enum":["admin","user"],"type":"string","description":"Administration level of the user.admin<\/strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.<\/note>user<\/strong>: Internal user can invite user and manage the files of his private directory and other directories with manage file access.<\/note>","example":"admin"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["can_not_update_role_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.can_not_update_role_error<\/strong>: User is not allowed to update someone's role.<\/note>","example":"can_not_update_role_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 409","type":"object","properties":{"code":{"enum":["drive_user_name_already_exists_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_user_name_already_exists_error<\/strong>: Drive username already exists.<\/note>","example":"drive_user_name_already_exists_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Users"],"summary":"Delete user","description":"Deletes a drive user resource. Also removes all access, share links and invitations associated with the user.","operationId":"kDriveDeleteUserV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"User Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"notify":{"title":"notify","type":"boolean","description":"Whether the deleted user should be notified by email, false by default."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/{user_id}\/manager":{"patch":{"tags":["Drive > Users"],"summary":"Update user manager right","description":"Update the role in the manager","operationId":"kDriveUpdateUserManagerRightV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"User Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["roles"],"type":"object","properties":{"roles":{"title":"roles","type":"array","items":{"title":"item","enum":["statistic","technical"],"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/{user_id}\/lock":{"post":{"tags":["Drive > Users"],"summary":"Lock user","description":"Sets status to locked, preventing access to drive.","operationId":"kDriveLockUserV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"User Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"User not associated with drive","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["user_not_associated_with_drive"],"type":"string","description":"Error code","example":"user_not_associated_with_drive"},"description":{"enum":["User not associated with drive"],"type":"string","description":"Description of the error","example":"User not associated with drive"}},"description":"Error object"}}}]},"examples":{"User not associated with drive":{"summary":"Example","value":{"result":"error","error":{"code":"user_not_associated_with_drive","description":"User not associated with drive","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/users\/{user_id}\/unlock":{"post":{"tags":["Drive > Users"],"summary":"Unlock user","description":"Sets status to active, restoring access to drive.","operationId":"kDriveUnlockUserV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"User Identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"User not associated with drive","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["user_not_associated_with_drive"],"type":"string","description":"Error code","example":"user_not_associated_with_drive"},"description":{"enum":["User not associated with drive"],"type":"string","description":"Description of the error","example":"User not associated with drive"}},"description":"Error object"}}}]},"examples":{"User not associated with drive":{"summary":"Example","value":{"result":"error","error":{"code":"user_not_associated_with_drive","description":"User not associated with drive","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/activities":{"get":{"tags":["Drive > Activity"],"summary":"Get drive activities of all the users.","description":"Get all activities from drive as defined in options","operationId":"kDriveGetDriveActivitiesOfAllTheUsersV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"},{"style":"form","explode":true,"schema":{"title":"actions","type":"array","items":{"title":"item","enum":["acl_insert","acl_main_users_insert","acl_main_users_remove","acl_main_users_update","acl_remove","acl_team_insert","acl_team_remove","acl_team_update","acl_update","acl_user_insert","acl_user_remove","acl_user_update","category_create","category_delete","category_update","collaborative_folder_access","collaborative_folder_create","collaborative_folder_delete","collaborative_folder_update","collaborative_user_access","collaborative_user_create","collaborative_user_delete","comment_create","comment_delete","comment_like","comment_resolve","comment_unlike","comment_update","exchange_pro_create","file_access","file_categorize","file_color_delete","file_color_update","file_create","file_delete","file_favorite_create","file_favorite_remove","file_ia_categorize","file_move","file_move_out","file_rename","file_rename_alias","file_restore","file_restore_inherited","file_share_create","file_share_delete","file_share_update","file_trash","file_trash_inherited","file_uncategorize","file_update","file_update_mime_type","maintenance_added","maintenance_removed","rewind_ended","rewind_started","share_link_create","share_link_delete","share_link_show","share_link_update","trash_empty","trash_empty_auto","update_trash_settings","user_connected","user_create","user_delete","user_restore","user_update"],"type":"string","description":"Logged interaction type of activities on the drive or file.acl_insert<\/strong>: Technical: when a new group access to a file\/directory is create.<\/note>acl_main_users_insert<\/strong>: Logged when the main kDrive team access to a file\/directory is created.<\/note>acl_main_users_remove<\/strong>: Logged when the main kDrive team to a file\/directory is removed.<\/note>acl_main_users_update<\/strong>: Logged when the main kDrive team to a file\/directory is modified.<\/note>acl_remove<\/strong>: Technical: when a group access to a file\/directory is removed.<\/note>acl_team_insert<\/strong>: Logged when a team access to a file\/directory is created.<\/note>acl_team_remove<\/strong>: Logged when a team access to a file\/directory is removed.<\/note>acl_team_update<\/strong>: Logged when a team access to a file\/directory is modified.<\/note>acl_update<\/strong>: Technical: when a group access to a file\/directory is modified.<\/note>acl_user_insert<\/strong>: Logged when an user\/admin access to a file\/directory is created.<\/note>acl_user_remove<\/strong>: Logged when an user\/admin access to a file\/directory is removed.<\/note>acl_user_update<\/strong>: Logged when an user\/admin access to a file\/directory is modified.<\/note>category_create<\/strong>: Logged when a new category is added.<\/note>category_delete<\/strong>: Logged when a category is deleted.<\/note>category_update<\/strong>: Logged when a category is renamed.<\/note>collaborative_folder_access<\/strong>: Logged when an user\/guest access to the dropbox.<\/note>collaborative_folder_create<\/strong>: Logged when an user create a dropbox.<\/note>collaborative_folder_delete<\/strong>: Logged when an user delete the dropbox.<\/note>collaborative_folder_update<\/strong>: Logged when an user update settings of the dropbox.<\/note>collaborative_user_access<\/strong>: Logged when an user\/guest upload to the dropbox.<\/note>collaborative_user_create<\/strong>: Logged when an user\/guest add his information before uploading to the dropbox.<\/note>collaborative_user_delete<\/strong>: Logged when an user remove the directory to the dropbox.<\/note>comment_create<\/strong>: Logged when an user\/admin add a comment on a file.<\/note>comment_delete<\/strong>: Logged when an user\/admin delete a comment on a file.<\/note>comment_like<\/strong>: Logged when an user\/admin like a comment on a file.<\/note>comment_resolve<\/strong>: Logged when an user\/admin resolve a comment on a file.<\/note>comment_unlike<\/strong>: Logged when an user\/admin unlike a comment on a file.<\/note>comment_update<\/strong>: Logged when an user\/admin update a comment on a file.<\/note>exchange_pro_create<\/strong>: Technical: no used.<\/note>file_access<\/strong>: Logged when an user\/guest access to the file.<\/note>file_categorize<\/strong>: Logged when a category is added to the file\/directory.<\/note>file_color_delete<\/strong>: Logged when a directory color is removed.<\/note>file_color_update<\/strong>: Logged when a directory color changed.<\/note>file_create<\/strong>: Logged when on the first file creation.<\/note>file_delete<\/strong>: Logged when the file is deleted.<\/note>file_favorite_create<\/strong>: Logged when a file\/directory is flagged as favorites.<\/note>file_favorite_remove<\/strong>: Logged when a file\/directory is unflagged from favorites.<\/note>file_ia_categorize<\/strong>: Logged when a file is categorized by the ia.<\/note>file_move<\/strong>: Logged when the file is added inside a directory.<\/note>file_move_out<\/strong>: Logged when the file is removed from a directory.<\/note>file_rename<\/strong>: Logged when the file is renamed.<\/note>file_rename_alias<\/strong>: Logged when a root file is renamed by an external user (only visible for the external user).<\/note>file_restore<\/strong>: Logged when the file is restored from the trash.<\/note>file_share_create<\/strong>: Logged when an external user access to a file\/directory is created.<\/note>file_share_delete<\/strong>: Logged when an external user access to a file\/directory is removed.<\/note>file_share_update<\/strong>: Logged when an external user access to a file\/directory is modified to another permission.<\/note>file_trash<\/strong>: Logged when the file is sent to trash.<\/note>file_uncategorize<\/strong>: Logged when a category is removed to the file\/directory.<\/note>file_update<\/strong>: Logged when the file is updated.<\/note>file_update_mime_type<\/strong>: Logged when a file mime_type is updated.<\/note>rewind_ended<\/strong>: Logged when the user ended a rewind.<\/note>rewind_started<\/strong>: Logged when the user started a rewind.<\/note>share_link_create<\/strong>: Logged when a public share link to a file\/directory is created.<\/note>share_link_delete<\/strong>: Logged when a public share link to a file\/directory is deleted.<\/note>share_link_show<\/strong>: Logged when a public share link to a file\/directory is seen by someone else.<\/note>share_link_update<\/strong>: Logged when a public share link to a file\/directory is modified.<\/note>trash_empty<\/strong>: Logged when the user empties the trash.<\/note>trash_empty_auto<\/strong>: Logged when the trash empties old files automatically.<\/note>update_trash_settings<\/strong>: Logged when the user changes trash the settings.<\/note>user_connected<\/strong>: Logged when an user is connected to the drive.<\/note>user_create<\/strong>: Logged when an user\/admin is added to the drive.<\/note>user_delete<\/strong>: Logged when an user\/admin has been removed of the drive.<\/note>user_restore<\/strong>: Logged when an user\/admin has been restored of the drive.<\/note>user_update<\/strong>: Logged when an user\/admin information has changed.<\/note>","example":"acl_insert"}},"name":"actions","in":"query"},{"style":"form","explode":true,"schema":{"title":"depth","enum":["children","file","folder","unlimited"],"type":"string"},"name":"depth","in":"query"},{"style":"form","explode":true,"schema":{"title":"files","maxItems":500,"minItems":1,"type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"List of files for which to retrieve activities"},"name":"files","in":"query"},{"style":"form","explode":true,"schema":{"title":"from","type":"integer"},"name":"from","in":"query"},{"style":"form","explode":true,"schema":{"title":"terms","minLength":3,"type":"string"},"name":"terms","in":"query"},{"style":"form","explode":true,"schema":{"title":"until","type":"integer"},"name":"until","in":"query"},{"style":"form","explode":true,"schema":{"title":"users","type":"array","items":{"title":"item","type":"integer"}},"name":"users","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["created_at"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[created_at]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ActivityFile"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/activities\/reports":{"get":{"tags":["Drive > Activity > Report"],"summary":"List reports","description":"List of activity reports.","operationId":"kDriveListReportsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"users","type":"array","items":{"title":"item","type":"integer"}},"name":"users","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["created_at","start_at","end_at","status","size"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[created_at]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ActivityReport"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Activity > Report"],"summary":"Create report","description":"Create a new report.","operationId":"kDriveCreateReportV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"actions":{"title":"actions","type":"array","items":{"title":"item","enum":["acl_insert","acl_main_users_insert","acl_main_users_remove","acl_main_users_update","acl_remove","acl_team_insert","acl_team_remove","acl_team_update","acl_update","acl_user_insert","acl_user_remove","acl_user_update","category_create","category_delete","category_update","collaborative_folder_access","collaborative_folder_create","collaborative_folder_delete","collaborative_folder_update","collaborative_user_access","collaborative_user_create","collaborative_user_delete","comment_create","comment_delete","comment_like","comment_resolve","comment_unlike","comment_update","exchange_pro_create","file_access","file_categorize","file_color_delete","file_color_update","file_create","file_delete","file_favorite_create","file_favorite_remove","file_ia_categorize","file_move","file_move_out","file_rename","file_rename_alias","file_restore","file_restore_inherited","file_share_create","file_share_delete","file_share_update","file_trash","file_trash_inherited","file_uncategorize","file_update","file_update_mime_type","maintenance_added","maintenance_removed","rewind_ended","rewind_started","share_link_create","share_link_delete","share_link_show","share_link_update","trash_empty","trash_empty_auto","update_trash_settings","user_connected","user_create","user_delete","user_restore","user_update"],"type":"string","description":"Logged interaction type of activities on the drive or file.acl_insert<\/strong>: Technical: when a new group access to a file\/directory is create.<\/note>acl_main_users_insert<\/strong>: Logged when the main kDrive team access to a file\/directory is created.<\/note>acl_main_users_remove<\/strong>: Logged when the main kDrive team to a file\/directory is removed.<\/note>acl_main_users_update<\/strong>: Logged when the main kDrive team to a file\/directory is modified.<\/note>acl_remove<\/strong>: Technical: when a group access to a file\/directory is removed.<\/note>acl_team_insert<\/strong>: Logged when a team access to a file\/directory is created.<\/note>acl_team_remove<\/strong>: Logged when a team access to a file\/directory is removed.<\/note>acl_team_update<\/strong>: Logged when a team access to a file\/directory is modified.<\/note>acl_update<\/strong>: Technical: when a group access to a file\/directory is modified.<\/note>acl_user_insert<\/strong>: Logged when an user\/admin access to a file\/directory is created.<\/note>acl_user_remove<\/strong>: Logged when an user\/admin access to a file\/directory is removed.<\/note>acl_user_update<\/strong>: Logged when an user\/admin access to a file\/directory is modified.<\/note>category_create<\/strong>: Logged when a new category is added.<\/note>category_delete<\/strong>: Logged when a category is deleted.<\/note>category_update<\/strong>: Logged when a category is renamed.<\/note>collaborative_folder_access<\/strong>: Logged when an user\/guest access to the dropbox.<\/note>collaborative_folder_create<\/strong>: Logged when an user create a dropbox.<\/note>collaborative_folder_delete<\/strong>: Logged when an user delete the dropbox.<\/note>collaborative_folder_update<\/strong>: Logged when an user update settings of the dropbox.<\/note>collaborative_user_access<\/strong>: Logged when an user\/guest upload to the dropbox.<\/note>collaborative_user_create<\/strong>: Logged when an user\/guest add his information before uploading to the dropbox.<\/note>collaborative_user_delete<\/strong>: Logged when an user remove the directory to the dropbox.<\/note>comment_create<\/strong>: Logged when an user\/admin add a comment on a file.<\/note>comment_delete<\/strong>: Logged when an user\/admin delete a comment on a file.<\/note>comment_like<\/strong>: Logged when an user\/admin like a comment on a file.<\/note>comment_resolve<\/strong>: Logged when an user\/admin resolve a comment on a file.<\/note>comment_unlike<\/strong>: Logged when an user\/admin unlike a comment on a file.<\/note>comment_update<\/strong>: Logged when an user\/admin update a comment on a file.<\/note>exchange_pro_create<\/strong>: Technical: no used.<\/note>file_access<\/strong>: Logged when an user\/guest access to the file.<\/note>file_categorize<\/strong>: Logged when a category is added to the file\/directory.<\/note>file_color_delete<\/strong>: Logged when a directory color is removed.<\/note>file_color_update<\/strong>: Logged when a directory color changed.<\/note>file_create<\/strong>: Logged when on the first file creation.<\/note>file_delete<\/strong>: Logged when the file is deleted.<\/note>file_favorite_create<\/strong>: Logged when a file\/directory is flagged as favorites.<\/note>file_favorite_remove<\/strong>: Logged when a file\/directory is unflagged from favorites.<\/note>file_ia_categorize<\/strong>: Logged when a file is categorized by the ia.<\/note>file_move<\/strong>: Logged when the file is added inside a directory.<\/note>file_move_out<\/strong>: Logged when the file is removed from a directory.<\/note>file_rename<\/strong>: Logged when the file is renamed.<\/note>file_rename_alias<\/strong>: Logged when a root file is renamed by an external user (only visible for the external user).<\/note>file_restore<\/strong>: Logged when the file is restored from the trash.<\/note>file_share_create<\/strong>: Logged when an external user access to a file\/directory is created.<\/note>file_share_delete<\/strong>: Logged when an external user access to a file\/directory is removed.<\/note>file_share_update<\/strong>: Logged when an external user access to a file\/directory is modified to another permission.<\/note>file_trash<\/strong>: Logged when the file is sent to trash.<\/note>file_uncategorize<\/strong>: Logged when a category is removed to the file\/directory.<\/note>file_update<\/strong>: Logged when the file is updated.<\/note>file_update_mime_type<\/strong>: Logged when a file mime_type is updated.<\/note>rewind_ended<\/strong>: Logged when the user ended a rewind.<\/note>rewind_started<\/strong>: Logged when the user started a rewind.<\/note>share_link_create<\/strong>: Logged when a public share link to a file\/directory is created.<\/note>share_link_delete<\/strong>: Logged when a public share link to a file\/directory is deleted.<\/note>share_link_show<\/strong>: Logged when a public share link to a file\/directory is seen by someone else.<\/note>share_link_update<\/strong>: Logged when a public share link to a file\/directory is modified.<\/note>trash_empty<\/strong>: Logged when the user empties the trash.<\/note>trash_empty_auto<\/strong>: Logged when the trash empties old files automatically.<\/note>update_trash_settings<\/strong>: Logged when the user changes trash the settings.<\/note>user_connected<\/strong>: Logged when an user is connected to the drive.<\/note>user_create<\/strong>: Logged when an user\/admin is added to the drive.<\/note>user_delete<\/strong>: Logged when an user\/admin has been removed of the drive.<\/note>user_restore<\/strong>: Logged when an user\/admin has been restored of the drive.<\/note>user_update<\/strong>: Logged when an user\/admin information has changed.<\/note>","example":"acl_insert"}},"depth":{"title":"depth","enum":["children","file","folder","unlimited"],"type":"string"},"files":{"title":"files","maxItems":500,"minItems":1,"type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"List of files for which to retrieve activities"},"from":{"title":"from","type":"integer"},"terms":{"title":"terms","minLength":3,"type":"string"},"until":{"title":"until","type":"integer"},"user_id":{"title":"user_id","type":"integer","description":"User identifier","nullable":true},"users":{"title":"users","type":"array","items":{"title":"item","type":"integer"}}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"integer"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/activities\/reports\/{report_id}":{"get":{"tags":["Drive > Activity > Report"],"summary":"Get report","description":"Get activity report.","operationId":"kDriveGetReportV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Report identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"report_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_ActivityReport"}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Activity > Report"],"summary":"Delete report","description":"Delete report.","operationId":"kDriveDeleteReportV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Report identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"report_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/activities\/reports\/{report_id}\/export":{"get":{"tags":["Drive > Activity > Report"],"summary":"Export report","description":"Download\/Export report.","operationId":"kDriveExportReportV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Report identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"report_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/csv":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/sizes":{"get":{"tags":["Drive > Statistics"],"summary":"Chart : files size","description":"Chart data, list files size value over time","operationId":"kDriveChartFilesSizeV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"interval","maximum":720,"minimum":1,"type":"integer","description":"Statistics hours interval between from and until"},"name":"interval","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"metrics","type":"array","items":{"title":"item","enum":["files","trash","versions"],"type":"string"}},"name":"metrics","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Chart"}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["no_metrics_requested_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.no_metrics_requested_error<\/strong>: No metrics were requested.<\/note>","example":"no_metrics_requested_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["unexpected_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.unexpected_error<\/strong>: Triggered when something unknown happens.<\/note>","example":"unexpected_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/sizes\/export":{"get":{"tags":["Drive > Statistics"],"summary":"Export : files size","description":"Exports sizes statistics as csv file","operationId":"kDriveExportFilesSizeV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"interval","maximum":720,"minimum":1,"type":"integer","description":"Statistics hours interval between from and until"},"name":"interval","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"metrics","type":"array","items":{"title":"item","enum":["files","trash","versions"],"type":"string"}},"name":"metrics","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"}],"responses":{"200":{"description":"OK","content":{"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["no_metrics_requested_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.no_metrics_requested_error<\/strong>: No metrics were requested.<\/note>","example":"no_metrics_requested_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["unexpected_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.unexpected_error<\/strong>: Triggered when something unknown happens.<\/note>","example":"unexpected_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/activities\/users":{"get":{"tags":["Drive > Statistics"],"summary":"Activities : Users","operationId":"kDriveActivitiesUsersV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ActiveMembers"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/activities\/shared_files":{"get":{"tags":["Drive > Statistics"],"summary":"Activities : Shared files","operationId":"kDriveActivitiesSharedFilesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Sharefile"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/activities":{"get":{"tags":["Drive > Statistics"],"summary":"Chart : Activities","description":"Chart data of activities metrics over time","operationId":"kDriveChartActivitiesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"interval","maximum":720,"minimum":1,"type":"integer","description":"Statistics hours interval between from and until"},"name":"interval","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"metric","enum":["devices","shared_files","users"],"type":"string"},"name":"metric","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Chart"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/activities\/export":{"get":{"tags":["Drive > Statistics"],"summary":"Export : Activities","description":"Exports activities statistics","operationId":"kDriveExportActivitiesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"interval","maximum":720,"minimum":1,"type":"integer","description":"Statistics hours interval between from and until"},"name":"interval","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"metric","enum":["devices","shared_files","users"],"type":"string"},"name":"metric","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"}],"responses":{"200":{"description":"OK","content":{"text\/csv":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/activities\/links":{"get":{"tags":["Drive > Statistics"],"summary":"Activities : ShareLinks","operationId":"kDriveActivitiesShareLinksV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"style":"form","explode":true,"schema":{"title":"max_view","type":"integer","description":"Filter result by a maximum view"},"name":"max_view","in":"query"},{"style":"form","explode":true,"schema":{"title":"min_view","type":"integer","description":"Filter result by a minimum view"},"name":"min_view","in":"query"},{"style":"form","explode":true,"schema":{"title":"rights","type":"array","items":{"title":"item","enum":["inherit","password","public"],"type":"string","description":"Rights required to view the share link.inherit<\/strong>: Share link is accessible only by users of the drive.<\/note>password<\/strong>: Share link is public but protected by a password.<\/note>public<\/strong>: Share link is public, no restriction set.<\/note>","example":"inherit"}},"name":"rights","in":"query"},{"style":"form","explode":true,"schema":{"title":"search","type":"string","description":" Search the exact match of share link filename when file is asked."},"name":"search","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"},{"style":"form","explode":true,"schema":{"title":"valid_until","maximum":9223372036830536943,"type":"integer","description":"Filter result by valid_until date","nullable":true},"name":"valid_until","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["unique_views","views","files.path","relevance"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[unique_views]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_StatisticSharelink"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/statistics\/activities\/links\/export":{"get":{"tags":["Drive > Statistics"],"summary":"Export : ShareLinks Activities","operationId":"kDriveExportShareLinksActivitiesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"from","maximum":9223372036830536943,"type":"integer","description":"Date from which to get statistics in unix-timestamp format"},"name":"from","in":"query"},{"style":"form","explode":true,"schema":{"title":"max_view","type":"integer","description":"Filter result by a maximum view"},"name":"max_view","in":"query"},{"style":"form","explode":true,"schema":{"title":"min_view","type":"integer","description":"Filter result by a minimum view"},"name":"min_view","in":"query"},{"style":"form","explode":true,"schema":{"title":"rights","type":"array","items":{"title":"item","enum":["inherit","password","public"],"type":"string","description":"Rights required to view the share link.inherit<\/strong>: Share link is accessible only by users of the drive.<\/note>password<\/strong>: Share link is public but protected by a password.<\/note>public<\/strong>: Share link is public, no restriction set.<\/note>","example":"inherit"}},"name":"rights","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"until","maximum":9223372036830536943,"type":"integer","description":"Date until when to get statistics in unix-timestamp format"},"name":"until","in":"query"},{"style":"form","explode":true,"schema":{"title":"valid_until","maximum":9223372036830536943,"type":"integer","description":"Filter result by valid_until date","nullable":true},"name":"valid_until","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/preferences":{"put":{"tags":["Drive > Settings"],"summary":"Update Preferences","description":"Updates the connected user preference for a drive.","operationId":"kDriveUpdatePreferencesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"color":{"title":"color","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","type":"string"},"default_page":{"title":"default_page","enum":["common","dropbox","favorite","last_modified","links","my_shared","private","shared_with_me","statistics","trash"],"type":"string"},"hide":{"title":"hide","type":"boolean"},"ui":{"title":"ui","type":"object","properties":{"rag_ocr_promotion":{"title":"rag_ocr_promotion","type":"boolean","description":"Display a promotion message about the RAG OCR if the user has not seen it yet"},"storage_limit_alert":{"title":"storage_limit_alert","type":"boolean","description":"Display an alert when storage limit has been reached"},"storage_warning_alert":{"title":"storage_warning_alert","type":"boolean","description":"Display an alert when storage limit is about to be reached"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"User not associated with drive","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["user_not_associated_with_drive"],"type":"string","description":"Error code","example":"user_not_associated_with_drive"},"description":{"enum":["User not associated with drive"],"type":"string","description":"Description of the error","example":"User not associated with drive"}},"description":"Error object"}}}]},"examples":{"User not associated with drive":{"summary":"Example","value":{"result":"error","error":{"code":"user_not_associated_with_drive","description":"User not associated with drive","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports":{"get":{"tags":["Drive > Files > External import"],"summary":"List imports","description":"List all external imports for the current user","operationId":"kDriveListImportsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > External import"],"summary":"Clean imports history","description":"Clean imports history for the current user.","operationId":"kDriveCleanImportsHistoryV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/sharelink":{"post":{"tags":["Drive > Files > External import"],"summary":"Import kDrive sharelink","description":"Import the content of a kDrive sharelink","operationId":"kDriveImportKDriveSharelinkV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["destination_folder_id","sharelink_uuid","source_drive_id"],"type":"object","properties":{"destination_folder_id":{"title":"destination_folder_id","type":"string","description":"ID of the destination folder for the copy"},"except_file_ids":{"title":"except_file_ids","type":"array","items":{"title":"item","type":"integer"},"description":"Ids of files to be imported. If missing or empty, all files of the share link will be imported"},"file_ids":{"title":"file_ids","type":"array","items":{"title":"item","type":"integer"},"description":"Ids of files to be imported. If missing or empty, all files of the share link will be imported"},"password":{"title":"password","type":"string","description":"Password to access the sharelink, if password-protected"},"sharelink_uuid":{"title":"sharelink_uuid","maxLength":36,"pattern":"^[A-Za-z0-9_-]+$","type":"string","description":"UUID of the share link to import"},"source_drive_id":{"title":"source_drive_id","type":"integer","description":"ID of the kDrive containing the sharelink to copy"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"}}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["quota_exceeded_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.quota_exceeded_error<\/strong>: Triggered when the quota storage of the drive is reached.<\/note>","example":"quota_exceeded_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_in_progress_in_directory_error","external_import_unsupported_app_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_in_progress_in_directory_error<\/strong>: Cannot perform action on the directory because an external import is in progress.<\/note>external_import_unsupported_app_error<\/strong>: The provided application is unsupported and cannot be used for an external import.<\/note>","example":"external_import_unsupported_app_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/kdrive":{"post":{"tags":["Drive > Files > External import"],"summary":"Import kDrive","description":"Import the content of a kDrive","operationId":"kDriveImportKDriveV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["application_drive_id","directory_id"],"type":"object","properties":{"application_drive_id":{"title":"application_drive_id","type":"string","description":"Id of the kDrive containing the content to import"},"directory_id":{"title":"directory_id","type":"integer","description":"Destination directory identifier"},"source_path":{"title":"source_path","type":"string","description":"Path of the folder to import, if different from the root"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"}}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["quota_exceeded_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.quota_exceeded_error<\/strong>: Triggered when the quota storage of the drive is reached.<\/note>","example":"quota_exceeded_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_in_progress_in_directory_error","external_import_unsupported_app_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_in_progress_in_directory_error<\/strong>: Cannot perform action on the directory because an external import is in progress.<\/note>external_import_unsupported_app_error<\/strong>: The provided application is unsupported and cannot be used for an external import.<\/note>","example":"external_import_unsupported_app_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/webdav":{"post":{"tags":["Drive > Files > External import"],"summary":"Import WebDAV app","description":"Import files and folders from a third party app supporting WebDAV","operationId":"kDriveImportWebDAVAppV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["application","directory_id","endpoint","login","password"],"type":"object","properties":{"application":{"title":"application","enum":["kdrive","nextcloud","owncloud","webdav"],"type":"string","description":"Supported service or third-party service identifier for external import.kdrive<\/strong>: Import from another kDrive.<\/note>nextcloud<\/strong>: Import from Nextcloud.<\/note>owncloud<\/strong>: Import from ownCloud.<\/note>webdav<\/strong>: Import from a generic WebDAV provider.<\/note>","example":"kdrive"},"directory_id":{"title":"directory_id","type":"integer","description":"Destination directory identifier"},"endpoint":{"title":"endpoint","type":"string","description":"Webdav endpoint"},"login":{"title":"login","maxLength":320,"type":"string","description":"Webdav login"},"password":{"title":"password","type":"string","description":"Webdav password"},"source_path":{"title":"source_path","type":"string","description":"Path of the folder to import, if different from the root"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"}}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["quota_exceeded_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.quota_exceeded_error<\/strong>: Triggered when the quota storage of the drive is reached.<\/note>","example":"quota_exceeded_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_in_progress_in_directory_error","external_import_unsupported_app_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_in_progress_in_directory_error<\/strong>: Cannot perform action on the directory because an external import is in progress.<\/note>external_import_unsupported_app_error<\/strong>: The provided application is unsupported and cannot be used for an external import.<\/note>","example":"external_import_unsupported_app_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/oauth":{"post":{"tags":["Drive > Files > External import"],"summary":"Import OAuth2 app","description":"Import files and folders from a third party app supporting OAuth2","operationId":"kDriveImportOAuth2AppV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["application","directory_id"],"type":"object","properties":{"access_token_id":{"title":"access_token_id","type":"integer","description":"ID of the authentication token for the application"},"application":{"title":"application","enum":["dropbox","google","google_drive","onedrive"],"type":"string","description":"Supported service or third-party service identifier for external import.dropbox<\/strong>: Import from Dropbox.<\/note>google<\/strong>: (deprecated) Import from Google Drive.<\/note>google_drive<\/strong>: Import from Google Drive.<\/note>onedrive<\/strong>: Import from Microsoft OneDrive.<\/note>","example":"dropbox"},"application_drive_id":{"title":"application_drive_id","pattern":"^[A-Za-z0-9_!-]+$","type":"string","description":"Application drive id selected"},"auth_code":{"title":"auth_code","maxLength":12288,"minLength":40,"pattern":"^[a-zA-Z0-9\\-._~\\+!\\\/]+$","type":"string","description":"Authentication code of the application"},"directory_id":{"title":"directory_id","type":"integer","description":"Destination directory identifier"},"skip_shared_files":{"title":"skip_shared_files","type":"boolean","description":"Skip shared files during the import, if the application supports it"},"source_path":{"title":"source_path","type":"string","description":"Path of the folder to import, if different from the root"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"}}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["quota_exceeded_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.quota_exceeded_error<\/strong>: Triggered when the quota storage of the drive is reached.<\/note>","example":"quota_exceeded_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_in_progress_in_directory_error","external_import_unsupported_app_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_in_progress_in_directory_error<\/strong>: Cannot perform action on the directory because an external import is in progress.<\/note>external_import_unsupported_app_error<\/strong>: The provided application is unsupported and cannot be used for an external import.<\/note>","example":"external_import_unsupported_app_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/oauth\/drives":{"get":{"tags":["Drive > Files > External import"],"summary":"List eligible drives","description":"List all drives eligible for import for the given third party application supporting OAuth2","operationId":"kDriveListEligibleDrivesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"access_token_id","type":"integer","description":"ID of the authentication token for the application"},"name":"access_token_id","in":"query"},{"required":true,"style":"form","explode":true,"schema":{"title":"application","enum":["dropbox","google","google_drive","onedrive"],"type":"string","description":"Supported service or third-party service identifier for external import.dropbox<\/strong>: Import from Dropbox.<\/note>google<\/strong>: (deprecated) Import from Google Drive.<\/note>google_drive<\/strong>: Import from Google Drive.<\/note>onedrive<\/strong>: Import from Microsoft OneDrive.<\/note>","example":"dropbox"},"name":"application","in":"query"},{"style":"form","explode":true,"schema":{"title":"auth_code","maxLength":12288,"minLength":40,"pattern":"^[a-zA-Z0-9\\-._~\\+!\\\/]+$","type":"string","description":"Authentication code of the application"},"name":"auth_code","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Thirdpartydriveslist"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["not_found_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_found_error<\/strong>: The requested data was not found.<\/note>","example":"not_found_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_unsupported_app_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_unsupported_app_error<\/strong>: The provided application is unsupported and cannot be used for an external import.<\/note>","example":"external_import_unsupported_app_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/{import_id}":{"get":{"tags":["Drive > Files > External import"],"summary":"List errored import files","description":"List all files which couldn't be imported properly.","operationId":"kDriveListErroredImportFilesV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"External import identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"import_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImportFile"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > External import"],"summary":"Delete import","description":"Delete a external import","operationId":"kDriveDeleteImportV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"External import identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"import_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_unsuitable_status_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_unsuitable_status_error<\/strong>: The provided import is not in a suitable status for this operation.<\/note>","example":"external_import_unsuitable_status_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/imports\/{import_id}\/cancel":{"put":{"tags":["Drive > Files > External import"],"summary":"Cancel import","description":"Cancel an external import.\nThis returns with a success if the import is already canceled or has ended.\n\nActual cancellation may take up to a few minutes to be effective","operationId":"kDriveCancelImportV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"External import identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"import_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/cancel":{"post":{"tags":["Drive > Files > Action"],"summary":"Undo action","description":"Cancel an action with a token or cancel actions with tokens.\nAn action token is a token returned with a CancelResource.\nUsed in bulk processes or specific actions like renaming a file.","operationId":"kDriveUndoActionV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"cancel_id":{"title":"cancel_id","pattern":"^[0-9a-f\\-]{36}$","type":"string","description":"The cancel identifier","example":"00000000-e89b-12d3-a456-000000000000"},"cancel_ids":{"title":"cancel_ids","type":"array","items":{"title":"item","pattern":"^[0-9a-f\\-]{36}$","type":"string","example":"00000000-e89b-12d3-a456-000000000000"},"description":"The cancel identifiers"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/91ac10ff_UUIDFeedbackresource"},{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_UUIDFeedbackresource"}}]}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["unexpected_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.unexpected_error<\/strong>: Triggered when something unknown happens.<\/note>","example":"unexpected_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/access\/requests\/{request_id}":{"get":{"tags":["Drive > Files > File\/Directory > Access > Request"],"summary":"Get requested file access from its id","description":"Show a given requested file access","operationId":"kDriveGetRequestedFileAccessFromItsIdV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"request_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_SanitizedFileAccessRequest"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/access\/requests\/{request_id}\/decline":{"put":{"tags":["Drive > Files > File\/Directory > Access > Request"],"summary":"Decline a file access request","description":"Decline a file access request","operationId":"kDriveDeclineAFileAccessRequestV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"request_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_SanitizedFileAccessRequest"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}":{"delete":{"tags":["Drive > Files > File\/Directory"],"summary":"Trash","description":"Trash a file, move it to the trash can.","operationId":"kDriveTrashV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_CancelResource"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["cannot_delete_object"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.cannot_delete_object<\/strong>: Triggered when the entity cannot be deleted.<\/note>","example":"cannot_delete_object"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/favorite":{"post":{"tags":["Drive > Files > Favorite"],"summary":"Favorite file","description":"Add a file in the favorites","operationId":"kDriveFavoriteFileV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > Favorite"],"summary":"Unfavorite file","description":"Remove a file from the favorites","operationId":"kDriveUnfavoriteFileV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/thumbnail":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Thumbnail","description":"Get file thumbnail.","operationId":"kDriveThumbnailV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"height","maximum":400,"minimum":10,"type":"integer","description":"The height of the thumbnail."},"name":"height","in":"query"},{"style":"form","explode":true,"schema":{"title":"width","maximum":400,"minimum":10,"type":"integer","description":"The width of the thumbnail."},"name":"width","in":"query"}],"responses":{"200":{"description":"OK","content":{"image\/*":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/preview":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Preview","description":"Get file preview.","operationId":"kDrivePreviewV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"as","enum":["pdf","text"],"type":"string","description":"Convert file before preview"},"name":"as","in":"query"},{"style":"form","explode":true,"schema":{"title":"height","maximum":10000,"minimum":10,"type":"integer","description":"The height of the preview. This parameter only works on image<\/note>"},"name":"height","in":"query"},{"style":"form","explode":true,"schema":{"title":"quality","maximum":100,"minimum":1,"type":"integer","description":"The quality of the preview. This parameter only works on image<\/note>"},"name":"quality","in":"query"},{"style":"form","explode":true,"schema":{"title":"width","maximum":10000,"minimum":10,"type":"integer","description":"The width of the preview. This parameter only works on image<\/note>"},"name":"width","in":"query"},{"style":"simple","explode":true,"schema":{"title":"x-kdrive-file-password","type":"string","description":"File password to open it for conversion, if the file is password-protected"},"name":"x-kdrive-file-password","in":"header"}],"responses":{"200":{"description":"OK","content":{"image\/*":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/download":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Download","description":"Download file content or directory as Zip file.\n\n\nPlease note that this may respond a 302 to actually download the requested content.\n<\/note>","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"as","enum":["pdf","text"],"type":"string","description":"Convert file before download"},"name":"as","in":"query"},{"style":"simple","explode":true,"schema":{"title":"x-kdrive-file-password","type":"string","description":"File password to open it for conversion, if the file is password-protected"},"name":"x-kdrive-file-password","in":"header"}],"responses":{"200":{"description":"OK","content":{"application\/octet-stream":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["bad_request_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.bad_request_error<\/strong>: Bad request, the request is invalid.<\/note>","example":"bad_request_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/rename":{"post":{"tags":["Drive > Files > File\/Directory"],"summary":"Rename","description":"Rename a file\/directory","operationId":"kDriveRenameV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["name"],"type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of the File\/Directory"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_CancelResource"}}}]}}}},"400":{"description":"Destination not a directory","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["destination_not_a_directory"],"type":"string","description":"Error code","example":"destination_not_a_directory"},"description":{"enum":["Destination not a directory"],"type":"string","description":"Description of the error","example":"Destination not a directory"}},"description":"Error object"}}}]},"examples":{"Destination not a directory":{"summary":"Example","value":{"result":"error","error":{"code":"destination_not_a_directory","description":"Destination not a directory","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/sizes":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Get size","description":"Get the size and storage_size of the File\/Directory with children, up to $depth.","operationId":"kDriveGetSizeV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"depth","enum":["folder","unlimited"],"type":"string"},"name":"depth","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_CountFileSize"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/hash":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Hash","description":"Get file hash.","operationId":"kDriveHashV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Filecontenthash"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/copy-to-drive":{"post":{"tags":["Drive > Files > File\/Directory"],"summary":"Copy to Drive","description":"Copy source file in source drive to destination drive at destination folder.","operationId":"kDriveCopyToDriveV2","parameters":[{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"drive_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["source_drive_id","source_file_id"],"type":"object","properties":{"source_drive_id":{"title":"source_drive_id","type":"integer","description":"Source Drive Identifier"},"source_file_id":{"title":"source_file_id","type":"integer","description":"Source File Identifier"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternalImport"}}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["external_import_size_computation_failed_error","quota_exceeded_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_size_computation_failed_error<\/strong>: Computing the import size failed; the import can't be executed.<\/note>quota_exceeded_error<\/strong>: Triggered when the quota storage of the drive is reached.<\/note>","example":"quota_exceeded_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["not_found_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_found_error<\/strong>: The requested data was not found.<\/note>","example":"not_found_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 422","type":"object","properties":{"code":{"enum":["external_import_unsupported_app_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.external_import_unsupported_app_error<\/strong>: The provided application is unsupported and cannot be used for an external import.<\/note>","example":"external_import_unsupported_app_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/temporary_url":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Get a file Temporary URL","description":"Get a Temporary URL for a given file\n\n\nNote that it is not possible to get a directory temporary URL.\n<\/note>","operationId":"kDriveGetAFileTemporaryURLV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"duration","maximum":86400,"minimum":60,"type":"integer","description":"How long before this link expires, in seconds"},"name":"duration","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_TemporaryURL"}}}]}}}},"400":{"description":"Cannot get a temporary url for a directory","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["cannot_get_a_temporary_url_for_a_directory"],"type":"string","description":"Error code","example":"cannot_get_a_temporary_url_for_a_directory"},"description":{"enum":["Cannot get a temporary url for a directory"],"type":"string","description":"Description of the error","example":"Cannot get a temporary url for a directory"}},"description":"Error object"}}}]},"examples":{"Cannot get a temporary url for a directory":{"summary":"Example","value":{"result":"error","error":{"code":"cannot_get_a_temporary_url_for_a_directory","description":"Cannot get a temporary url for a directory","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/versions":{"get":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"List","description":"Get list of file versions","operationId":"kDriveListV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["created_at","last_modified_at","keep_forever"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[created_at]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_FileVersionV2"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Delete all","description":"Delete all version for file.","operationId":"kDriveDeleteAllV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/versions\/current":{"put":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Update current","description":"Update current file version","operationId":"kDriveUpdateCurrentV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["keep_forever"],"type":"object","properties":{"keep_forever":{"title":"keep_forever","type":"boolean","description":"Indicate whether the current version should be kept forever"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/versions\/{version_id}":{"get":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Get","description":"Get file version information.","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Version identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"version_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_FileVersionV2"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Update","description":"Update file version","operationId":"kDriveUpdateV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Version identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"version_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["keep_forever"],"type":"object","properties":{"keep_forever":{"title":"keep_forever","type":"boolean","description":"Never delete this version from version history"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Delete","description":"Delete a file version.","operationId":"kDriveDeleteV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Version identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"version_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/versions\/{version_id}\/download":{"get":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Download","description":"Download file version.\n\n\nPlease note that this may respond a 302 to actually download the requested content.\n<\/note>","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Version identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"version_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/octet-stream":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/versions\/{version_id}\/restore":{"post":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Restore","description":"Restore a file version.","operationId":"kDriveRestoreV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Version identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"version_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_File"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/versions\/{version_id}\/restore\/{destination_directory_id}":{"post":{"tags":["Drive > Files > File\/Directory > Version"],"summary":"Restore to Directory","description":"Restore a file version as a copy in target directory, keeping current original intact.","operationId":"kDriveRestoreToDirectoryV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Version identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"version_id","in":"path"},{"description":"Directory identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"destination_directory_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"name":{"title":"name","type":"string","description":"Name of File in the destination Directory"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_File"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/requests":{"get":{"tags":["Drive > Files > File\/Directory > Access > Request"],"summary":"Get requested file access from a file id","description":"Show requested file access for a given file","operationId":"kDriveGetRequestedFileAccessFromAFileIdV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Access > Request"],"summary":"Create a new file access request","description":"Create a new file access request","operationId":"kDriveCreateANewFileAccessRequestV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"message":{"title":"message","type":"string","description":"Message provided by the requestor of new access","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_SanitizedFileAccessRequest"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/applications":{"post":{"tags":["Drive > Files > File\/Directory > Access"],"summary":"Allow external applications","description":"Get access for an external application","operationId":"kDriveAllowExternalApplicationsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["type"],"type":"object","properties":{"mode":{"title":"mode","enum":["edit","view"],"type":"string","description":"Asked mode to open the external wopi documents.edit<\/strong>: Open with the edit mode.<\/note>view<\/strong>: Open with the view mode.<\/note>","example":"edit"},"type":{"title":"type","enum":["365","collabora"],"type":"string","description":"List of applications.365<\/strong>: The 365 application.<\/note>collabora<\/strong>: The collabora application.<\/note>","example":"365"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackaccessresource_c3fdaa7f"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access":{"get":{"tags":["Drive > Files > File\/Directory > Access"],"summary":"Get multi-access","description":"Show access file information","operationId":"kDriveGetMultiaccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_FileAccess"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Access"],"summary":"Add multi-access","description":"Add multi-access to file","operationId":"kDriveAddMultiaccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right"],"type":"object","properties":{"emails":{"title":"emails","maxItems":100,"type":"array","items":{"title":"item","type":"string"}},"message":{"title":"message","type":"string","nullable":true},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"},"team_ids":{"title":"team_ids","maxItems":40,"type":"array","items":{"title":"item","type":"integer"}},"user_ids":{"title":"user_ids","maxItems":100,"type":"array","items":{"title":"item","type":"integer","description":"User identifier. Only user in the same Infomaniak group"}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackaccessresource_c3fdaa7f"}}}]}}}},"400":{"description":"Permission denied","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["permission_denied"],"type":"string","description":"Error code","example":"permission_denied"},"description":{"enum":["Permission denied"],"type":"string","description":"Description of the error","example":"Permission denied"}},"description":"Error object"}}}]},"examples":{"Permission denied":{"summary":"Example","value":{"result":"error","error":{"code":"permission_denied","description":"Permission denied","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/sync-parent":{"post":{"tags":["Drive > Files > File\/Directory > Access"],"summary":"Synchronize with parent rights","description":"Retrieve the parent access rights and apply them to the current file.\nAny further update on parent access rights will be propagated to this file, unless its access rights have been changed.","operationId":"kDriveSynchronizeWithParentRightsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/check":{"post":{"tags":["Drive > Files > File\/Directory > Access"],"summary":"Check access change","description":"Analyzes each user that has access to the drive by team, email or user identifier.\nThis method tries to find users for the given inputs:<\/br>\n> The emails are parsed to user identifiers if possible.<\/br>\n> The teams identifiers are parsed to multiple user identifiers.<\/br>\n> The users identifiers are parsed accordingly.<\/br><\/br>\nA right is required to simulate if a user needs to change their permissions to match it.","operationId":"kDriveCheckAccessChangeV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right"],"type":"object","properties":{"emails":{"title":"emails","maxItems":100,"type":"array","items":{"title":"item","type":"string"}},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"},"team_ids":{"title":"team_ids","maxItems":40,"type":"array","items":{"title":"item","type":"integer"}},"user_ids":{"title":"user_ids","maxItems":100,"type":"array","items":{"title":"item","type":"integer","description":"User identifier. Only user in the same Infomaniak group"}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Checkchangeaccessfeedbackresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/invitations":{"get":{"tags":["Drive > Files > File\/Directory > Access > Invitation"],"summary":"Invitation > get access","description":"Show invitation send and that has access to the File|Directory, pending and accepted invitation","operationId":"kDriveInvitationGetAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ExternInvitationFileAccess"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Access > Invitation"],"summary":"Add access","description":"Give access to the File|Directory by email","operationId":"kDriveAddAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["emails","right"],"type":"object","properties":{"emails":{"title":"emails","maxItems":100,"type":"array","items":{"title":"item","type":"string"}},"message":{"title":"message","type":"string","nullable":true},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackaccessresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/invitations\/check":{"post":{"tags":["Drive > Files > File\/Directory > Access > Invitation"],"summary":"Check access","description":"Check if an invitation exists or a drive invitation is currently pending","operationId":"kDriveCheckAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"emails":{"title":"emails","maxItems":100,"minItems":1,"type":"array","items":{"title":"item","type":"string"}},"user_ids":{"title":"user_ids","maxItems":100,"minItems":1,"type":"array","items":{"title":"item","minimum":1,"type":"integer"}}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackaccesspendinginvitationresource"}}}}]}}}},"400":{"description":"Permission denied","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["permission_denied"],"type":"string","description":"Error code","example":"permission_denied"},"description":{"enum":["Permission denied"],"type":"string","description":"Description of the error","example":"Permission denied"}},"description":"Error object"}}}]},"examples":{"Permission denied":{"summary":"Example","value":{"result":"error","error":{"code":"permission_denied","description":"Permission denied","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/teams":{"get":{"tags":["Drive > Files > File\/Directory > Access > Teams"],"summary":"Get access","description":"Show team that has access to the File|Directory","operationId":"kDriveGetAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_TeamFileAccess"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Access > Teams"],"summary":"Add access","description":"Give teams access to the File|Directory","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right"],"type":"object","properties":{"message":{"title":"message","type":"string","nullable":true},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"},"team_ids":{"title":"team_ids","maxItems":40,"type":"array","items":{"title":"item","type":"integer"}}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackaccessresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/teams\/{team_id}":{"put":{"tags":["Drive > Files > File\/Directory > Access > Teams"],"summary":"Update access","description":"Update the access permission of a team access","operationId":"kDriveUpdateAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Team identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"team_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right"],"type":"object","properties":{"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > File\/Directory > Access > Teams"],"summary":"Remove access","description":"Delete the access permission of a team access","operationId":"kDriveRemoveAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"Team identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"team_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/users":{"get":{"tags":["Drive > Files > File\/Directory > Access > Users"],"summary":"get access","description":"Show user that has access to the File|Directory","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Userfileaccess"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Access > Users"],"summary":"add access","description":"Give users access to the File|Directory","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right","user_ids"],"type":"object","properties":{"message":{"title":"message","type":"string","nullable":true},"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"},"user_ids":{"title":"user_ids","maxItems":100,"type":"array","items":{"title":"item","type":"integer","description":"User identifier. Only user in the same Infomaniak group"}}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackaccessresource"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 404","type":"object","properties":{"code":{"enum":["object_not_found"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.object_not_found<\/strong>: Triggered when the asked entity is not accessible.<\/note>","example":"object_not_found"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/users\/{user_id}":{"put":{"tags":["Drive > Files > File\/Directory > Access > Users"],"summary":"Update access","description":"Update the access permission of an access","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"User identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right"],"type":"object","properties":{"right":{"title":"right","enum":["manage","none","read","write"],"type":"string","description":"Access level of {name}.manage<\/strong>: Can share, write and read the file.<\/note>none<\/strong>: Can not act on the file.<\/note>read<\/strong>: Can only read the file.<\/note>write<\/strong>: Can write and read the file.<\/note>","example":"manage"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > File\/Directory > Access > Users"],"summary":"Remove access","description":"Delete access of a File\/Directory","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"User identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"User not associated with drive","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["user_not_associated_with_drive"],"type":"string","description":"Error code","example":"user_not_associated_with_drive"},"description":{"enum":["User not associated with drive"],"type":"string","description":"Description of the error","example":"User not associated with drive"}},"description":"Error object"}}}]},"examples":{"User not associated with drive":{"summary":"Example","value":{"result":"error","error":{"code":"user_not_associated_with_drive","description":"User not associated with drive","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/access\/force":{"post":{"tags":["Drive > Files > File\/Directory > Access > Users"],"summary":"Force write access","description":"Claim write access in a shared file","operationId":"kDriveForceWriteAccessV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Unsupported file type","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["unsupported_file_type"],"type":"string","description":"Error code","example":"unsupported_file_type"},"description":{"enum":["Unsupported file type"],"type":"string","description":"Description of the error","example":"Unsupported file type"}},"description":"Error object"}}}]},"examples":{"Unsupported file type":{"summary":"Example","value":{"result":"error","error":{"code":"unsupported_file_type","description":"Unsupported file type","errors":[]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 401","type":"object","properties":{"code":{"enum":["not_authorized"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.not_authorized<\/strong>: Triggered when the user is not authorized to access this resource.<\/note>","example":"not_authorized"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/link":{"get":{"tags":["Drive > Files > Share link > Manage"],"summary":"Get share-link","description":"Get a share link information","operationId":"kDriveGetSharelinkV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Drive > Files > Share link > Manage"],"summary":"Update share-link","description":"Update a share-link","operationId":"kDriveUpdateSharelinkV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"can_comment":{"title":"can_comment","type":"boolean","description":"Allow users to to comment the shared files. It takes the same value as can_edit if unset or null"},"can_download":{"title":"can_download","type":"boolean","description":"Allow users to download shared content"},"can_edit":{"title":"can_edit","type":"boolean","description":"Allow users to edit the file content using the shared link"},"can_request_access":{"title":"can_request_access","type":"boolean","description":"Allow connected users to join the folder via the shared link. It is not possible to join a file via a shared link"},"can_see_info":{"title":"can_see_info","type":"boolean","description":"Allow users to see information about the shared files"},"can_see_stats":{"title":"can_see_stats","type":"boolean","description":"Allow users to see statistics"},"password":{"title":"password","type":"string","description":"The password if the permission password is set"},"right":{"title":"right","enum":["inherit","password","public"],"type":"string"},"valid_until":{"title":"valid_until","type":"integer","description":"Maximum validity timestamp of the shared link","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > Share link > Manage"],"summary":"Create share-link","description":"Create a share link","operationId":"kDriveCreateSharelinkV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["right"],"type":"object","properties":{"can_comment":{"title":"can_comment","type":"boolean","description":"Allow users to to comment the shared files. It takes the same value as can_edit if unset or null"},"can_download":{"title":"can_download","type":"boolean","description":"Allow users to download shared content"},"can_edit":{"title":"can_edit","type":"boolean","description":"Allow users to edit the file content using the shared link"},"can_request_access":{"title":"can_request_access","type":"boolean","description":"Allow connected users to join the folder via the shared link. It is not possible to join a file via a shared link"},"can_see_info":{"title":"can_see_info","type":"boolean","description":"Allow users to see information about the shared files"},"can_see_stats":{"title":"can_see_stats","type":"boolean","description":"Allow users to see statistics"},"password":{"title":"password","type":"string","description":"The password if the permission password is set"},"right":{"title":"right","enum":["inherit","password","public"],"type":"string","description":"Permission of the shared link: no restriction (public), access by authenticated and authorized user (inherit) or public but protected by a password (password)"},"valid_until":{"title":"valid_until","type":"integer","description":"Maximum validity timestamp of the shared link","nullable":true}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_ShareLink"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > Share link > Manage"],"summary":"Remove share-link","description":"Delete a share link","operationId":"kDriveRemoveSharelinkV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/link\/invite":{"post":{"tags":["Drive > Files > Share link > Manage"],"summary":"Share link invite","description":"Send an email with the share link, to allow an user to upload files.","operationId":"kDriveShareLinkInviteV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"emails":{"title":"emails","maxItems":100,"minItems":1,"type":"array","items":{"title":"item","type":"string"},"description":"List of emails to invite"},"message":{"title":"message","type":"string","description":"Message to be sent","nullable":true},"user_ids":{"title":"user_ids","type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"List of user ids to invite by mail. Users must be in the drive's organisation "}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/dropbox":{"get":{"tags":["Drive > Files > Dropbox"],"summary":"Get dropbox","description":"Get dropbox by the directory identifier.\nA dropbox allows no logged users to upload files to this directory via an external dropbox link (see Drive > External Access > Dropbox).<\/note>","operationId":"kDriveGetDropboxV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Dropbox"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Drive > Files > Dropbox"],"summary":"Update dropbox","description":"Update and manage a dropbox.","operationId":"kDriveUpdateDropboxV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"alias":{"title":"alias","type":"string","description":"Alias of the dropbox","nullable":true},"email_when_finished":{"title":"email_when_finished","type":"boolean","description":"Send an email when done"},"limit_file_size":{"title":"limit_file_size","type":"integer","description":"Maximum accepted file size (bytes)","nullable":true},"password":{"title":"password","type":"string","description":"Password for protecting the dropbox","nullable":true},"valid_until":{"title":"valid_until","maximum":9223372036830536943,"type":"integer","description":"Maximum validity date","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > Dropbox"],"summary":"Convert a folder into a dropbox","description":"A dropbox allows unauthenticated users to upload files onto the drive via a public link (see Drive > External Access > Dropbox).<\/note>","operationId":"kDriveConvertAFolderIntoADropboxV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"alias":{"title":"alias","type":"string","description":"Alias of the dropbox","nullable":true},"email_when_finished":{"title":"email_when_finished","type":"boolean","description":"Send an email when done"},"limit_file_size":{"title":"limit_file_size","type":"integer","description":"Maximum accepted file size (bytes)","nullable":true},"password":{"title":"password","type":"string","description":"Password for protecting the dropbox","nullable":true},"valid_until":{"title":"valid_until","maximum":9223372036830536943,"type":"integer","description":"Maximum validity date","nullable":true}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Dropbox"}}}]}}}},"400":{"description":"Collaborative folder already exists for file","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["collaborative_folder_already_exists_for_file"],"type":"string","description":"Error code","example":"collaborative_folder_already_exists_for_file"},"description":{"enum":["Collaborative folder already exists for file"],"type":"string","description":"Description of the error","example":"Collaborative folder already exists for file"}},"description":"Error object"}}}]},"examples":{"Collaborative folder already exists for file":{"summary":"Example","value":{"result":"error","error":{"code":"collaborative_folder_already_exists_for_file","description":"Collaborative folder already exists for file","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > Dropbox"],"summary":"Delete dropbox","description":"Delete a Dropbox Directory resource","operationId":"kDriveDeleteDropboxV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/dropbox\/invite":{"post":{"tags":["Drive > Files > Dropbox"],"summary":"Dropbox invite","description":"Send an email with the dropbox external link, to allow an user to upload files.","operationId":"kDriveDropboxInviteV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"emails":{"title":"emails","maxItems":100,"minItems":1,"type":"array","items":{"title":"item","type":"string"},"description":"List of emails to invite"},"message":{"title":"message","type":"string","description":"Message to be sent","nullable":true},"user_ids":{"title":"user_ids","type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"List of user ids to invite by mail. Users must be in the drive's organisation "}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/comments":{"get":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Get file comments","description":"Retrieve all Comments from a file","operationId":"kDriveGetFileCommentsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["created_at"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[created_at]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Comment"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Add comment","description":"Add a comment to a file.","operationId":"kDriveAddCommentV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["body"],"type":"object","properties":{"body":{"title":"body","type":"string"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Comment"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/comments\/{comment_id}":{"get":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Get comment reply","description":"Retrieve reply responding to a comment on file.","operationId":"kDriveGetCommentReplyV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"comment_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"$ref":"#\/components\/parameters\/Page","schema":{"type":"integer","default":1}},{"$ref":"#\/components\/parameters\/PerPage","schema":{"maximum":1000,"minimum":1,"type":"integer","default":10}},{"$ref":"#\/components\/parameters\/Total"},{"$ref":"#\/components\/parameters\/OrderBy","schema":{"enum":["created_at"]}},{"$ref":"#\/components\/parameters\/Order"},{"$ref":"#\/components\/parameters\/OrderFor","schema":{"enum":["asc","desc"],"example":"order_for[created_at]=asc"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Comment"}}}},{"$ref":"#\/components\/schemas\/Pagination"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"put":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Modify comment","description":"Modify a comment on a file.","operationId":"kDriveModifyCommentV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"comment_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"body":{"title":"body","type":"string"},"is_resolved":{"title":"is_resolved","type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Add comment reply","description":"Add a reply to a comment.","operationId":"kDriveAddCommentReplyV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"comment_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["body"],"type":"object","properties":{"body":{"title":"body","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_Comment"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Delete comment","description":"Delete a comment from a file.","operationId":"kDriveDeleteCommentV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"comment_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/comments\/{comment_id}\/like":{"post":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Like comment","description":"Add a like to the comment","operationId":"kDriveLikeCommentV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"comment_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/{file_id}\/comments\/{comment_id}\/unlike":{"post":{"tags":["Drive > Files > File\/Directory > Comment"],"summary":"Unlike comment","description":"Remove a like from the Comment","operationId":"kDriveUnlikeCommentV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"comment_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/exists":{"post":{"tags":["Drive > Files"],"summary":"Check file' existence","description":"Check if some files ids still exists in the drive","operationId":"kDriveCheckFileExistenceV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","required":["ids"],"type":"object","properties":{"ids":{"title":"ids","type":"array","items":{"title":"item","type":"integer"},"description":"The ids of the files to check"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_Feedbackresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/files\/archives\/{archive_uuid}":{"get":{"tags":["Drive > Files > Archive"],"summary":"Download archive","description":"You can download an archive\/zip with the token provided by the route drive\/{drive_id}\/files\/archives<\/a>.\n\nPlease note that this may respond a 302 to actually download the requested content.<\/note>","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Archive uuid","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"archive_uuid","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/zip":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["too_many_files_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.too_many_files_error<\/strong>: To many files, max limit reached.<\/note>","example":"too_many_files_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/trash":{"delete":{"tags":["Drive > Files > Trash"],"summary":"Empty trash","description":"Empty all trashed files","operationId":"kDriveEmptyTrashV2","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/trash\/count":{"get":{"tags":["Drive > Files > Trash"],"summary":"Count Directory\/File in Trash","description":"Count the number of Directory and File in trash","operationId":"kDriveCountDirectoryFileInTrashV2","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_CountFile"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/trash\/{file_id}":{"delete":{"tags":["Drive > Files > Trash"],"summary":"Remove file","description":"Delete a file from trash (remove it completely)","operationId":"kDriveRemoveFileV2","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"the file identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/trash\/{file_id}\/restore":{"post":{"tags":["Drive > Files > Trash"],"summary":"Restore file","description":"Restore a specific Directory or File from the trash","operationId":"kDriveRestoreFileV2","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"the file identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"requestBody":{"description":"Request body of the called URI","content":{"application\/json":{"schema":{"title":"Request body","required":["destination_directory_id"],"type":"object","properties":{"destination_directory_id":{"title":"destination_directory_id","type":"integer","description":"Destination directory identifier"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/91ac10ff_CancelResource"},{"type":"boolean"}]}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error","lock_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.lock_error<\/strong>: Action impossible. There is a lock on the file\/directory.<\/note>forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/trash\/{file_id}\/thumbnail":{"get":{"tags":["Drive > Files > Trash"],"summary":"Get thumbnail","description":"Get thumbnail of trashed file","operationId":"kDriveGetThumbnailV2","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"the file identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"height","maximum":400,"minimum":10,"type":"integer","description":"The height of the thumbnail."},"name":"height","in":"query"},{"style":"form","explode":true,"schema":{"title":"width","maximum":400,"minimum":10,"type":"integer","description":"The width of the thumbnail."},"name":"width","in":"query"}],"responses":{"200":{"description":"OK","content":{"image\/*":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/trash\/{file_id}\/count":{"get":{"tags":["Drive > Files > Trash"],"summary":"Count Directory\/File in trashed Directory","description":"Count the number of Directory and File","operationId":"kDriveCountDirectoryFileInTrashedDirectoryV2","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"the file identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_CountFile"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"deprecated":true,"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/upload":{"delete":{"tags":["Drive > Files > File\/Directory > Upload"],"summary":"Cancel by path","description":"Cancel an upload by its path (for instance, if the session token is unknown)","operationId":"kDriveCancelByPathV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"directory_id":{"title":"directory_id","type":"integer","description":"The directory destination root of the new file. Must be a directory.\n If the identifier is unknown you can use only directory_path<\/strong>.<\/note>\n The identifier 1<\/strong> is the user root folder.<\/note>\n Required without directory_path<\/strong><\/note>","example":1000},"directory_path":{"title":"directory_path","type":"string","description":"The destination path of the new file. If the directory_id<\/strong> is provided the directory path is used as a relative path, otherwise it will be used as an absolute path. The destination should be a directory.\n If the directory path does not exist, folders are created automatically.<\/note>\n The path is a destination path, the file name should not be provided at the end.<\/note>\n Required without directory_id<\/strong>.<\/note>","nullable":true,"example":"\/Directory\/SubDirectory"},"file_name":{"title":"file_name","maxLength":255,"type":"string","description":"The name of the file to create.\n Slashes will be replaced by colons.<\/note>\n Maximum bytes size is 255<\/note>","example":"file.txt"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/upload\/session\/{session_token}":{"delete":{"tags":["Drive > Files > File\/Directory > Upload > Session"],"summary":"Cancel session","description":"Cancel an upload by its token. If you want to stop the upload and close the session to explicitly erase the file\/upload.\n\nWhen a session is started, it can be used for a maximum of 4 hours. It will be automatically canceled afterwards.\n<\/note>","operationId":"kDriveCancelSessionV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Session token uuid","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"session_token","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Destination not writable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"enum":["destination_not_writable"],"type":"string","description":"Error code","example":"destination_not_writable"},"description":{"enum":["Destination not writable"],"type":"string","description":"Description of the error","example":"Destination not writable"}},"description":"Error object"}}}]},"examples":{"Destination not writable":{"summary":"Example","value":{"result":"error","error":{"code":"destination_not_writable","description":"Destination not writable","errors":[]}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/drive\/{drive_id}\/upload\/session\/batch":{"delete":{"tags":["Drive > Files > File\/Directory > Upload > Session"],"summary":"Batch : cancel sessions","description":"Cancel multiple session tokens. If you want to stop the upload and close one or more sessions to explicitly erase file(s)\/upload(s).\n\nWhen a session is started, it can be used for a maximum of 4 hours. It will be automatically canceled afterwards.\n<\/note>\n\n The batch cannot exceed 1,000 sessions.\n<\/note>","operationId":"kDriveBatchCancelSessionsV2","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"required":true,"style":"form","explode":true,"schema":{"title":"tokens","type":"array","items":{"title":"item","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string","description":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"}},"name":"tokens","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_UUIDFeedbackresource"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"429":{"description":"Response","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 429","type":"object","properties":{"code":{"enum":["too_many_upload_sessions_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.too_many_upload_sessions_error<\/strong>: You have reached the maximum limit of simultaneous upload sessions. Wait before some uploads finish before retrying.<\/note>","example":"too_many_upload_sessions_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/2\/app\/{drive_id}\/share\/{sharelink_uuid}\/archive":{"post":{"tags":["Drive > Files > Share link > Archive"],"summary":"Build archive","description":"Build an archive from files in the share link. The archive can then be downloaded using the drive\/{drive_id}\/share\/{sharelink_uuid}\/download<\/a> route.\n<\/br><\/br>\nThe file identifiers should be in the same parent directory.\n<\/note>\n<\/br>\nThe archive should contain at least one file and may not contain more than 20,000 files.\n<\/note>","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Sharelink token","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"sharelink_uuid","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Request body","type":"object","properties":{"except_file_ids":{"title":"except_file_ids","type":"array","items":{"title":"item","type":"integer"},"description":"Array of files to exclude from the request; only used when parent_id is set, meaningless otherwise"},"file_ids":{"title":"file_ids","type":"array","items":{"title":"item","type":"integer"},"description":"Array of files to include in the request; required without parent_id"},"parent_id":{"title":"parent_id","type":"integer","description":"The directory containing the files to include in the request; required without file_ids"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/91ac10ff_ArchiveResource"}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["file_not_in_share_link_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.file_not_in_share_link_error<\/strong>: The provided file or directory does not belong to the given share link.<\/note>","example":"file_not_in_share_link_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}}}},"\/2\/app\/{drive_id}\/share\/{sharelink_uuid}\/archive\/{archive_uuid}\/download":{"get":{"tags":["Drive > Files > Share link > Archive"],"summary":"Download sharelink archive","description":"You can download an archive\/zip with the archive token provided by the route drive\/{drive_id}\/share\/{sharelink_uuid}\/download<\/a>.\nPlease note that this may respond a 302 to actually download the requested content.<\/note>","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"Sharelink token","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"sharelink_uuid","in":"path"},{"description":"Archive token","required":true,"style":"simple","explode":true,"schema":{"type":"string"},"name":"archive_uuid","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/zip":{"schema":{"$ref":"#\/components\/schemas\/91ac10ff_Stream"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["too_many_files_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.too_many_files_error<\/strong>: To many files, max limit reached.<\/note>","example":"too_many_files_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}}}},"\/3\/drive\/{drive_id}\/activities":{"get":{"tags":["Drive > Activity"],"summary":"Get drive activities of all the users.","description":"Get all activities from drive as defined in options","operationId":"kDriveGetDriveActivitiesOfAllTheUsersV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"cursor","type":"string","description":"The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list"},"name":"cursor","in":"query"},{"style":"form","explode":true,"schema":{"title":"limit","maximum":1000,"minimum":5,"type":"integer","description":"The maximum number of items returned","default":10},"name":"limit","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_by","type":"array","items":{"enum":["created_at"],"type":"string","description":"The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted"}},"name":"order_by","in":"query"},{"style":"form","explode":true,"schema":{"title":"order","enum":["asc","desc"],"type":"string","description":"Specifies the default sorting direction for any `order_by` parameters provided"},"name":"order","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_for","type":"array","items":{"enum":["asc","desc"],"type":"string","description":"Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[created_at]=asc`"}},"name":"order_for","in":"query"},{"description":"Override the language of the request, in most cases when an e-mail is triggered in the request.","style":"form","explode":true,"schema":{"enum":["de","en","es","fr","it"],"type":"string"},"name":"lang","in":"query"},{"style":"form","explode":true,"schema":{"title":"actions","type":"array","items":{"title":"item","enum":["acl_insert","acl_main_users_insert","acl_main_users_remove","acl_main_users_update","acl_remove","acl_team_insert","acl_team_remove","acl_team_update","acl_update","acl_user_insert","acl_user_remove","acl_user_update","category_create","category_delete","category_update","collaborative_folder_access","collaborative_folder_create","collaborative_folder_delete","collaborative_folder_update","collaborative_user_access","collaborative_user_create","collaborative_user_delete","comment_create","comment_delete","comment_like","comment_resolve","comment_unlike","comment_update","exchange_pro_create","file_access","file_categorize","file_color_delete","file_color_update","file_create","file_delete","file_favorite_create","file_favorite_remove","file_ia_categorize","file_move","file_move_out","file_rename","file_rename_alias","file_restore","file_restore_inherited","file_share_create","file_share_delete","file_share_update","file_trash","file_trash_inherited","file_uncategorize","file_update","file_update_mime_type","maintenance_added","maintenance_removed","rewind_ended","rewind_started","share_link_create","share_link_delete","share_link_show","share_link_update","trash_empty","trash_empty_auto","update_trash_settings","user_connected","user_create","user_delete","user_restore","user_update"],"type":"string","description":"Logged interaction type of activities on the drive or file.acl_insert<\/strong>: Technical: when a new group access to a file\/directory is create.<\/note>acl_main_users_insert<\/strong>: Logged when the main kDrive team access to a file\/directory is created.<\/note>acl_main_users_remove<\/strong>: Logged when the main kDrive team to a file\/directory is removed.<\/note>acl_main_users_update<\/strong>: Logged when the main kDrive team to a file\/directory is modified.<\/note>acl_remove<\/strong>: Technical: when a group access to a file\/directory is removed.<\/note>acl_team_insert<\/strong>: Logged when a team access to a file\/directory is created.<\/note>acl_team_remove<\/strong>: Logged when a team access to a file\/directory is removed.<\/note>acl_team_update<\/strong>: Logged when a team access to a file\/directory is modified.<\/note>acl_update<\/strong>: Technical: when a group access to a file\/directory is modified.<\/note>acl_user_insert<\/strong>: Logged when an user\/admin access to a file\/directory is created.<\/note>acl_user_remove<\/strong>: Logged when an user\/admin access to a file\/directory is removed.<\/note>acl_user_update<\/strong>: Logged when an user\/admin access to a file\/directory is modified.<\/note>category_create<\/strong>: Logged when a new category is added.<\/note>category_delete<\/strong>: Logged when a category is deleted.<\/note>category_update<\/strong>: Logged when a category is renamed.<\/note>collaborative_folder_access<\/strong>: Logged when an user\/guest access to the dropbox.<\/note>collaborative_folder_create<\/strong>: Logged when an user create a dropbox.<\/note>collaborative_folder_delete<\/strong>: Logged when an user delete the dropbox.<\/note>collaborative_folder_update<\/strong>: Logged when an user update settings of the dropbox.<\/note>collaborative_user_access<\/strong>: Logged when an user\/guest upload to the dropbox.<\/note>collaborative_user_create<\/strong>: Logged when an user\/guest add his information before uploading to the dropbox.<\/note>collaborative_user_delete<\/strong>: Logged when an user remove the directory to the dropbox.<\/note>comment_create<\/strong>: Logged when an user\/admin add a comment on a file.<\/note>comment_delete<\/strong>: Logged when an user\/admin delete a comment on a file.<\/note>comment_like<\/strong>: Logged when an user\/admin like a comment on a file.<\/note>comment_resolve<\/strong>: Logged when an user\/admin resolve a comment on a file.<\/note>comment_unlike<\/strong>: Logged when an user\/admin unlike a comment on a file.<\/note>comment_update<\/strong>: Logged when an user\/admin update a comment on a file.<\/note>exchange_pro_create<\/strong>: Technical: no used.<\/note>file_access<\/strong>: Logged when an user\/guest access to the file.<\/note>file_categorize<\/strong>: Logged when a category is added to the file\/directory.<\/note>file_color_delete<\/strong>: Logged when a directory color is removed.<\/note>file_color_update<\/strong>: Logged when a directory color changed.<\/note>file_create<\/strong>: Logged when on the first file creation.<\/note>file_delete<\/strong>: Logged when the file is deleted.<\/note>file_favorite_create<\/strong>: Logged when a file\/directory is flagged as favorites.<\/note>file_favorite_remove<\/strong>: Logged when a file\/directory is unflagged from favorites.<\/note>file_ia_categorize<\/strong>: Logged when a file is categorized by the ia.<\/note>file_move<\/strong>: Logged when the file is added inside a directory.<\/note>file_move_out<\/strong>: Logged when the file is removed from a directory.<\/note>file_rename<\/strong>: Logged when the file is renamed.<\/note>file_rename_alias<\/strong>: Logged when a root file is renamed by an external user (only visible for the external user).<\/note>file_restore<\/strong>: Logged when the file is restored from the trash.<\/note>file_share_create<\/strong>: Logged when an external user access to a file\/directory is created.<\/note>file_share_delete<\/strong>: Logged when an external user access to a file\/directory is removed.<\/note>file_share_update<\/strong>: Logged when an external user access to a file\/directory is modified to another permission.<\/note>file_trash<\/strong>: Logged when the file is sent to trash.<\/note>file_uncategorize<\/strong>: Logged when a category is removed to the file\/directory.<\/note>file_update<\/strong>: Logged when the file is updated.<\/note>file_update_mime_type<\/strong>: Logged when a file mime_type is updated.<\/note>rewind_ended<\/strong>: Logged when the user ended a rewind.<\/note>rewind_started<\/strong>: Logged when the user started a rewind.<\/note>share_link_create<\/strong>: Logged when a public share link to a file\/directory is created.<\/note>share_link_delete<\/strong>: Logged when a public share link to a file\/directory is deleted.<\/note>share_link_show<\/strong>: Logged when a public share link to a file\/directory is seen by someone else.<\/note>share_link_update<\/strong>: Logged when a public share link to a file\/directory is modified.<\/note>trash_empty<\/strong>: Logged when the user empties the trash.<\/note>trash_empty_auto<\/strong>: Logged when the trash empties old files automatically.<\/note>update_trash_settings<\/strong>: Logged when the user changes trash the settings.<\/note>user_connected<\/strong>: Logged when an user is connected to the drive.<\/note>user_create<\/strong>: Logged when an user\/admin is added to the drive.<\/note>user_delete<\/strong>: Logged when an user\/admin has been removed of the drive.<\/note>user_restore<\/strong>: Logged when an user\/admin has been restored of the drive.<\/note>user_update<\/strong>: Logged when an user\/admin information has changed.<\/note>","example":"acl_insert"}},"name":"actions","in":"query"},{"style":"form","explode":true,"schema":{"title":"depth","enum":["children","file","folder","unlimited"],"type":"string"},"name":"depth","in":"query"},{"style":"form","explode":true,"schema":{"title":"files","maxItems":500,"minItems":1,"type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"List of files for which to retrieve activities"},"name":"files","in":"query"},{"style":"form","explode":true,"schema":{"title":"from","type":"integer"},"name":"from","in":"query"},{"style":"form","explode":true,"schema":{"title":"terms","minLength":3,"type":"string"},"name":"terms","in":"query"},{"style":"form","explode":true,"schema":{"title":"until","type":"integer"},"name":"until","in":"query"},{"style":"form","explode":true,"schema":{"title":"users","type":"array","items":{"title":"item","type":"integer"}},"name":"users","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ActivityFileV3"}}}},{"$ref":"#\/components\/schemas\/91ac10ff_NavigatorResponse"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/activities\/total":{"get":{"tags":["Drive > Activity"],"summary":"Get total count drive activities of all the users.","description":"Get total of all activities from drive as defined in options","operationId":"kDriveGetTotalCountDriveActivitiesOfAllTheUsersV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"actions","type":"array","items":{"title":"item","enum":["acl_insert","acl_main_users_insert","acl_main_users_remove","acl_main_users_update","acl_remove","acl_team_insert","acl_team_remove","acl_team_update","acl_update","acl_user_insert","acl_user_remove","acl_user_update","category_create","category_delete","category_update","collaborative_folder_access","collaborative_folder_create","collaborative_folder_delete","collaborative_folder_update","collaborative_user_access","collaborative_user_create","collaborative_user_delete","comment_create","comment_delete","comment_like","comment_resolve","comment_unlike","comment_update","exchange_pro_create","file_access","file_categorize","file_color_delete","file_color_update","file_create","file_delete","file_favorite_create","file_favorite_remove","file_ia_categorize","file_move","file_move_out","file_rename","file_rename_alias","file_restore","file_restore_inherited","file_share_create","file_share_delete","file_share_update","file_trash","file_trash_inherited","file_uncategorize","file_update","file_update_mime_type","maintenance_added","maintenance_removed","rewind_ended","rewind_started","share_link_create","share_link_delete","share_link_show","share_link_update","trash_empty","trash_empty_auto","update_trash_settings","user_connected","user_create","user_delete","user_restore","user_update"],"type":"string","description":"Logged interaction type of activities on the drive or file.acl_insert<\/strong>: Technical: when a new group access to a file\/directory is create.<\/note>acl_main_users_insert<\/strong>: Logged when the main kDrive team access to a file\/directory is created.<\/note>acl_main_users_remove<\/strong>: Logged when the main kDrive team to a file\/directory is removed.<\/note>acl_main_users_update<\/strong>: Logged when the main kDrive team to a file\/directory is modified.<\/note>acl_remove<\/strong>: Technical: when a group access to a file\/directory is removed.<\/note>acl_team_insert<\/strong>: Logged when a team access to a file\/directory is created.<\/note>acl_team_remove<\/strong>: Logged when a team access to a file\/directory is removed.<\/note>acl_team_update<\/strong>: Logged when a team access to a file\/directory is modified.<\/note>acl_update<\/strong>: Technical: when a group access to a file\/directory is modified.<\/note>acl_user_insert<\/strong>: Logged when an user\/admin access to a file\/directory is created.<\/note>acl_user_remove<\/strong>: Logged when an user\/admin access to a file\/directory is removed.<\/note>acl_user_update<\/strong>: Logged when an user\/admin access to a file\/directory is modified.<\/note>category_create<\/strong>: Logged when a new category is added.<\/note>category_delete<\/strong>: Logged when a category is deleted.<\/note>category_update<\/strong>: Logged when a category is renamed.<\/note>collaborative_folder_access<\/strong>: Logged when an user\/guest access to the dropbox.<\/note>collaborative_folder_create<\/strong>: Logged when an user create a dropbox.<\/note>collaborative_folder_delete<\/strong>: Logged when an user delete the dropbox.<\/note>collaborative_folder_update<\/strong>: Logged when an user update settings of the dropbox.<\/note>collaborative_user_access<\/strong>: Logged when an user\/guest upload to the dropbox.<\/note>collaborative_user_create<\/strong>: Logged when an user\/guest add his information before uploading to the dropbox.<\/note>collaborative_user_delete<\/strong>: Logged when an user remove the directory to the dropbox.<\/note>comment_create<\/strong>: Logged when an user\/admin add a comment on a file.<\/note>comment_delete<\/strong>: Logged when an user\/admin delete a comment on a file.<\/note>comment_like<\/strong>: Logged when an user\/admin like a comment on a file.<\/note>comment_resolve<\/strong>: Logged when an user\/admin resolve a comment on a file.<\/note>comment_unlike<\/strong>: Logged when an user\/admin unlike a comment on a file.<\/note>comment_update<\/strong>: Logged when an user\/admin update a comment on a file.<\/note>exchange_pro_create<\/strong>: Technical: no used.<\/note>file_access<\/strong>: Logged when an user\/guest access to the file.<\/note>file_categorize<\/strong>: Logged when a category is added to the file\/directory.<\/note>file_color_delete<\/strong>: Logged when a directory color is removed.<\/note>file_color_update<\/strong>: Logged when a directory color changed.<\/note>file_create<\/strong>: Logged when on the first file creation.<\/note>file_delete<\/strong>: Logged when the file is deleted.<\/note>file_favorite_create<\/strong>: Logged when a file\/directory is flagged as favorites.<\/note>file_favorite_remove<\/strong>: Logged when a file\/directory is unflagged from favorites.<\/note>file_ia_categorize<\/strong>: Logged when a file is categorized by the ia.<\/note>file_move<\/strong>: Logged when the file is added inside a directory.<\/note>file_move_out<\/strong>: Logged when the file is removed from a directory.<\/note>file_rename<\/strong>: Logged when the file is renamed.<\/note>file_rename_alias<\/strong>: Logged when a root file is renamed by an external user (only visible for the external user).<\/note>file_restore<\/strong>: Logged when the file is restored from the trash.<\/note>file_share_create<\/strong>: Logged when an external user access to a file\/directory is created.<\/note>file_share_delete<\/strong>: Logged when an external user access to a file\/directory is removed.<\/note>file_share_update<\/strong>: Logged when an external user access to a file\/directory is modified to another permission.<\/note>file_trash<\/strong>: Logged when the file is sent to trash.<\/note>file_uncategorize<\/strong>: Logged when a category is removed to the file\/directory.<\/note>file_update<\/strong>: Logged when the file is updated.<\/note>file_update_mime_type<\/strong>: Logged when a file mime_type is updated.<\/note>rewind_ended<\/strong>: Logged when the user ended a rewind.<\/note>rewind_started<\/strong>: Logged when the user started a rewind.<\/note>share_link_create<\/strong>: Logged when a public share link to a file\/directory is created.<\/note>share_link_delete<\/strong>: Logged when a public share link to a file\/directory is deleted.<\/note>share_link_show<\/strong>: Logged when a public share link to a file\/directory is seen by someone else.<\/note>share_link_update<\/strong>: Logged when a public share link to a file\/directory is modified.<\/note>trash_empty<\/strong>: Logged when the user empties the trash.<\/note>trash_empty_auto<\/strong>: Logged when the trash empties old files automatically.<\/note>update_trash_settings<\/strong>: Logged when the user changes trash the settings.<\/note>user_connected<\/strong>: Logged when an user is connected to the drive.<\/note>user_create<\/strong>: Logged when an user\/admin is added to the drive.<\/note>user_delete<\/strong>: Logged when an user\/admin has been removed of the drive.<\/note>user_restore<\/strong>: Logged when an user\/admin has been restored of the drive.<\/note>user_update<\/strong>: Logged when an user\/admin information has changed.<\/note>","example":"acl_insert"}},"name":"actions","in":"query"},{"style":"form","explode":true,"schema":{"title":"depth","enum":["children","file","folder","unlimited"],"type":"string"},"name":"depth","in":"query"},{"style":"form","explode":true,"schema":{"title":"files","maxItems":500,"minItems":1,"type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"List of files for which to retrieve activities"},"name":"files","in":"query"},{"style":"form","explode":true,"schema":{"title":"from","type":"integer"},"name":"from","in":"query"},{"style":"form","explode":true,"schema":{"title":"terms","minLength":3,"type":"string"},"name":"terms","in":"query"},{"style":"form","explode":true,"schema":{"title":"until","type":"integer"},"name":"until","in":"query"},{"style":"form","explode":true,"schema":{"title":"users","type":"array","items":{"title":"item","type":"integer"}},"name":"users","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ActivityFileV3"}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/users":{"get":{"tags":["Drive"],"summary":"Get users","description":"Retrieves a list of users. By default, this endpoint returns all active account users. Using the types parameter, you can filter by: account, drive role, or pending invitation.\n\n
The results are filtered based on the requesting user's permissions.<\/note>","operationId":"kDriveGetUsersV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"cursor","type":"string","description":"The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list"},"name":"cursor","in":"query"},{"style":"form","explode":true,"schema":{"title":"limit","maximum":1000,"minimum":5,"type":"integer","description":"The maximum number of items returned","default":10},"name":"limit","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_by","type":"array","items":{"enum":["display_name","first_name","last_name"],"type":"string","description":"The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted"}},"name":"order_by","in":"query"},{"style":"form","explode":true,"schema":{"title":"order","enum":["asc","desc"],"type":"string","description":"Specifies the default sorting direction for any `order_by` parameters provided"},"name":"order","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_for","type":"array","items":{"enum":["asc","desc"],"type":"string","description":"Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[display_name]=asc`"}},"name":"order_for","in":"query"},{"style":"form","explode":true,"schema":{"title":"search","type":"string","description":"Search user by his first name, last name or email"},"name":"search","in":"query"},{"style":"form","explode":true,"schema":{"title":"status","type":"array","items":{"title":"item","enum":["active","deleted","locked","pending","withdrawn"],"type":"string"},"description":"Status of the resource `{name}`"},"name":"status","in":"query"},{"style":"form","explode":true,"schema":{"title":"types","type":"array","items":{"title":"item","enum":["account","admin","expired","external","pending","user"],"type":"string"}},"name":"types","in":"query"},{"style":"form","explode":true,"schema":{"title":"user_ids","maxItems":100,"type":"array","items":{"title":"item","minimum":1,"type":"integer"},"description":"User identifiers"},"name":"user_ids","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_UserV3"}}}},{"$ref":"#\/components\/schemas\/91ac10ff_NavigatorResponse"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/wake":{"post":{"tags":["Drive"],"summary":"Wake a sleeping drive up","description":"Request a {@link Drive} with a {@link MaintenanceType::Asleep} maintenance to wake up.","operationId":"kDriveWakeASleepingDriveUpV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"boolean"}}}]}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 400","type":"object","properties":{"code":{"enum":["drive_is_not_asleep_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_not_asleep_error<\/strong>: Drive is not asleep.<\/note>","example":"drive_is_not_asleep_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"access_denied"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"500":{"description":"Internal Server Error","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 500","type":"object","properties":{"code":{"enum":["drive_wont_wake_up_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_wont_wake_up_error<\/strong>: Something went wrong while trying to wake this drive up.<\/note>","example":"drive_wont_wake_up_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/files\/{file_id}":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Get File\/Directory","description":"Get File\/Directory by file identifier.\nIf you need to access the root directory, set the 'file_id' parameter to '1'; from there, you can navigate to other files and directories.","operationId":"kDriveGetFileDirectoryV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"},{"$ref":"#\/components\/schemas\/91ac10ff_FileV3"}]}}}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/files\/{file_id}\/files":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Get files in directory","description":"Get paginate children file\/directory of specific directory (file identifier)","operationId":"kDriveGetFilesInDirectoryV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"cursor","type":"string","description":"The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list"},"name":"cursor","in":"query"},{"style":"form","explode":true,"schema":{"title":"limit","maximum":1000,"minimum":5,"type":"integer","description":"The maximum number of items returned","default":10},"name":"limit","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_by","type":"array","items":{"enum":["added_at","last_modified_at","mime_type","name","revised_at","size","type","updated_at"],"type":"string","description":"The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted"}},"name":"order_by","in":"query"},{"style":"form","explode":true,"schema":{"title":"order","enum":["asc","desc"],"type":"string","description":"Specifies the default sorting direction for any `order_by` parameters provided"},"name":"order","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_for","type":"array","items":{"enum":["asc","desc"],"type":"string","description":"Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`"}},"name":"order_for","in":"query"},{"style":"form","explode":true,"schema":{"title":"type","type":"array","items":{"title":"item","enum":["dir","file","vault"],"type":"string","description":"The file type structure either a File, a Directory or a Vault","example":"file"}},"name":"type","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"oneOf":[{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_DirectoryV3"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_FileV3"}}]}}},{"$ref":"#\/components\/schemas\/91ac10ff_NavigatorResponse"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/files\/{file_id}\/activities":{"get":{"tags":["Drive > Activity"],"summary":"Get file activities","description":"Get activities of a file|directory","operationId":"kDriveGetFileActivitiesV3","parameters":[{"description":"the drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"the file identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"description":"*Optional* : Allows loading additional data about a resource, which may include related resources.","style":"form","explode":true,"schema":{"type":"string"},"name":"with","in":"query"},{"style":"form","explode":true,"schema":{"title":"cursor","type":"string","description":"The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list"},"name":"cursor","in":"query"},{"style":"form","explode":true,"schema":{"title":"limit","maximum":1000,"minimum":5,"type":"integer","description":"The maximum number of items returned","default":10},"name":"limit","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_by","type":"array","items":{"enum":["created_at"],"type":"string","description":"The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted"}},"name":"order_by","in":"query"},{"style":"form","explode":true,"schema":{"title":"order","enum":["asc","desc"],"type":"string","description":"Specifies the default sorting direction for any `order_by` parameters provided"},"name":"order","in":"query"},{"style":"form","explode":true,"schema":{"title":"order_for","type":"array","items":{"enum":["asc","desc"],"type":"string","description":"Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[created_at]=asc`"}},"name":"order_for","in":"query"},{"style":"form","explode":true,"schema":{"title":"actions","type":"array","items":{"title":"item","enum":["collaborative_folder_access","collaborative_folder_create","collaborative_folder_delete","collaborative_folder_update","collaborative_user_access","collaborative_user_create","collaborative_user_delete","comment_create","comment_delete","comment_like","comment_resolve","comment_unlike","comment_update","file_access","file_categorize","file_color_delete","file_color_update","file_create","file_delete","file_favorite_create","file_favorite_remove","file_ia_categorize","file_move","file_move_out","file_rename","file_rename_alias","file_restore","file_share_create","file_share_delete","file_share_update","file_trash","file_uncategorize","file_update","share_link_create","share_link_delete","share_link_show","share_link_update"],"type":"string","description":"Logged interaction type of activities on the drive or file.collaborative_folder_access<\/strong>: Logged when an user\/guest access to the dropbox.<\/note>collaborative_folder_create<\/strong>: Logged when an user create a dropbox.<\/note>collaborative_folder_delete<\/strong>: Logged when an user delete the dropbox.<\/note>collaborative_folder_update<\/strong>: Logged when an user update settings of the dropbox.<\/note>collaborative_user_access<\/strong>: Logged when an user\/guest upload to the dropbox.<\/note>collaborative_user_create<\/strong>: Logged when an user\/guest add his information before uploading to the dropbox.<\/note>collaborative_user_delete<\/strong>: Logged when an user remove the directory to the dropbox.<\/note>comment_create<\/strong>: Logged when an user\/admin add a comment on a file.<\/note>comment_delete<\/strong>: Logged when an user\/admin delete a comment on a file.<\/note>comment_like<\/strong>: Logged when an user\/admin like a comment on a file.<\/note>comment_resolve<\/strong>: Logged when an user\/admin resolve a comment on a file.<\/note>comment_unlike<\/strong>: Logged when an user\/admin unlike a comment on a file.<\/note>comment_update<\/strong>: Logged when an user\/admin update a comment on a file.<\/note>file_access<\/strong>: Logged when an user\/guest access to the file.<\/note>file_categorize<\/strong>: Logged when a category is added to the file\/directory.<\/note>file_color_delete<\/strong>: Logged when a directory color is removed.<\/note>file_color_update<\/strong>: Logged when a directory color changed.<\/note>file_create<\/strong>: Logged when on the first file creation.<\/note>file_delete<\/strong>: Logged when the file is deleted.<\/note>file_favorite_create<\/strong>: Logged when a file\/directory is flagged as favorites.<\/note>file_favorite_remove<\/strong>: Logged when a file\/directory is unflagged from favorites.<\/note>file_ia_categorize<\/strong>: Logged when a file is categorized by the ia.<\/note>file_move<\/strong>: Logged when the file is added inside a directory.<\/note>file_move_out<\/strong>: Logged when the file is removed from a directory.<\/note>file_rename<\/strong>: Logged when the file is renamed.<\/note>file_rename_alias<\/strong>: Logged when a root file is renamed by an external user (only visible for the external user).<\/note>file_restore<\/strong>: Logged when the file is restored from the trash.<\/note>file_share_create<\/strong>: Logged when an external user access to a file\/directory is created.<\/note>file_share_delete<\/strong>: Logged when an external user access to a file\/directory is removed.<\/note>file_share_update<\/strong>: Logged when an external user access to a file\/directory is modified to another permission.<\/note>file_trash<\/strong>: Logged when the file is sent to trash.<\/note>file_uncategorize<\/strong>: Logged when a category is removed to the file\/directory.<\/note>file_update<\/strong>: Logged when the file is updated.<\/note>share_link_create<\/strong>: Logged when a public share link to a file\/directory is created.<\/note>share_link_delete<\/strong>: Logged when a public share link to a file\/directory is deleted.<\/note>share_link_show<\/strong>: Logged when a public share link to a file\/directory is seen by someone else.<\/note>share_link_update<\/strong>: Logged when a public share link to a file\/directory is modified.<\/note>","example":"collaborative_folder_access"}},"name":"actions","in":"query"},{"style":"form","explode":true,"schema":{"title":"depth","enum":["children","file","folder","unlimited"],"type":"string"},"name":"depth","in":"query"},{"style":"form","explode":true,"schema":{"title":"from","type":"integer"},"name":"from","in":"query"},{"style":"form","explode":true,"schema":{"title":"terms","minLength":3,"type":"string"},"name":"terms","in":"query"},{"style":"form","explode":true,"schema":{"title":"until","type":"integer"},"name":"until","in":"query"},{"style":"form","explode":true,"schema":{"title":"users","type":"array","items":{"title":"item","type":"integer"}},"name":"users","in":"query"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/Response"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/91ac10ff_ActivityFileV3"}}}},{"$ref":"#\/components\/schemas\/91ac10ff_NavigatorResponse"}]}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 403","type":"object","properties":{"code":{"enum":["access_denied","forbidden_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.forbidden_error<\/strong>: Triggered when user does not have the file permission.<\/note>access_denied<\/strong>: Triggered the user do not have access to this resource.<\/note>","example":"forbidden_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}},"503":{"description":"Service Unavailable","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/ErrorResponse"},{"type":"object","properties":{"error":{"title":"The error returned when the http code is 503","type":"object","properties":{"code":{"enum":["drive_is_in_maintenance_error"],"type":"string","description":"The error code returned, the description<\/strong> add details relative to this code.drive_is_in_maintenance_error<\/strong>: Drive is in maintenance.<\/note>","example":"drive_is_in_maintenance_error"},"description":{"type":"string","description":"More details about the error","example":"Something wrong, additional information about the error code"}}}}}]}}}}},"security":[{"bearerAuth":[]}]}},"\/3\/drive\/{drive_id}\/files\/{file_id}\/count":{"get":{"tags":["Drive > Files > File\/Directory"],"summary":"Count element in directory","description":"Get number of element in a directory by ID","operationId":"kDriveCountElementInDirectoryV3","parameters":[{"description":"Drive identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"drive_id","in":"path"},{"description":"File identifier","required":true,"style":"simple","explode":true,"schema":{"type":"integer"},"name":"file_id","in":"path"},{"style":"form","explode":true,"schema":{"title":"depth","enum":["folder","unlimited"],"type":"string","description":"Specifies how elements are counted within given folder. Choose either to count only within the specified folder (folder) or to include subfolders in the count (unlimited). The default mode is folder.