Skip to content

About

A simple Ruby SDK for integrating with the ONLYOFFICE DocSpace API

Topics

docspaceintegrationonlyofficesdk

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

docspace-api-sdk

The ONLYOFFICE DocSpace SDK for Ruby is a library that provides tools for integrating and managing DocSpace features within your applications. It simplifies interaction with the DocSpace API by offering ready-to-use methods and models.

For more information, please visit https://helpdesk.onlyoffice.com/hc/en-us

Building

To build the Ruby gem, run the following command:

gem build docspace-api-sdk.gemspec

Consuming

To use the generated SDK in your project, choose one of the following options.

From published gem (recommended)

Add this to your Gemfile:

gem 'docspace-api-sdk', '~> 4.0.0'

Then run:

bundle install

From local build

gem install ./docspace-api-sdk-4.0.0.gem

From Git

gem 'docspace-api-sdk', git: 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Getting Started

Please follow the building instruction and then run the following Ruby code:

# Load the gem
require 'docspace-api-sdk'

# Setup authorization
DocspaceApiSdk.configure do |config|
  # Configure API key authorization: cookieAuth
  config.api_key['asc_auth_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['asc_auth_key'] = 'Bearer'

  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = DocspaceApiSdk::AI::AIApi.new
ai_approve_tool_call_request = DocspaceApiSdk::AiApproveToolCallRequest.new({result: 3.56, thread_id: 'thread_id_example', message_id: 'message_id_example', idx: 3.56, message: DocspaceApiSdk::AiThreadMessageLike.new({role: 'user', content: DocspaceApiSdk::AiThreadMessageLikeContent.new})}) # AiApproveToolCallRequest | 


begin
  # Approve tool call
  result = api_instance.ai_approve_tool_call(ai_approve_tool_call_request)
  p result
rescue DocspaceApiSdk::ApiError => e
  puts "Exception when calling AI::AIApi->ai_approve_tool_call: #{e}"
end

Documentation For Authorization

Authentication schemes defined for the API:

cookieAuth

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location: Cookie

bearerAuth

  • Type: Bearer authentication

asc_auth_key

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location: Cookie

Basic

  • Type: HTTP basic authentication

Bearer

  • Type: Bearer authentication (JWT)

ApiKeyBearer

  • Type: API key
  • API key parameter name: ApiKeyBearer
  • Location: HTTP header

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: {{authBaseUrl}}/oauth2/authorize
  • Token Url: {{authBaseUrl}}/oauth2/token
  • Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

  • Type: OpenId Connect
  • OpenId Connect URL: {{authBaseUrl}}/.well-known/openid-configuration

x-signature

  • Type: API key
  • API key parameter name: x-signature
  • Location: Cookie

Rate Limiting

All API responses may include the following rate limiting headers:

Header Description
X-RateLimit-Limit Sliding window rate limit: 1500 requests per minute per user/IP.
X-RateLimit-Remaining Number of requests remaining in the current sliding window (1500 req/min). Concurrent limits also apply: 50 parallel GET requests, 15 parallel POST/PUT requests.
X-RateLimit-Reset Unix timestamp (seconds) when the current sliding window rate limit resets.
Retry-After Seconds to wait before retrying. Up to 60s for the sliding window (1500 req/min), up to 86400s for the daily POST/PUT limit (10000/day).

Documentation for API Endpoints

All URIs are relative to https://your-docspace.onlyoffice.com

API Endpoints tables:

AI
Method HTTP request Description
AI::AIApi
ai_approve_tool_call POST /api/2.0/ai/ai/approve-tool-call Approve tool call
ai_deny_tool_call POST /api/2.0/ai/ai/deny-tool-call Deny tool call
ai_regenerate_stream POST /api/2.0/ai/ai/regenerate-stream Regenerate stream
ai_send POST /api/2.0/ai/ai/send Run an AI action
ai_send_custom POST /api/2.0/ai/ai/send-custom Send custom
ai_send_with_stream POST /api/2.0/ai/ai/send-with-stream Send with stream
ai_send_with_stream_open_ai POST /api/2.0/ai/ai/send-with-stream-openai Stream a chat in OpenAI format
AI::AgentsApi
ai_agents_create POST /api/2.0/ai/agents Create an agent
ai_agents_delete DELETE /api/2.0/ai/agents/{id} Delete an agent
ai_agents_get GET /api/2.0/ai/agents/{id} Get an agent
ai_agents_list GET /api/2.0/ai/agents List agents
ai_agents_news GET /api/2.0/ai/agents/news List agent news items
ai_agents_reset_quota PUT /api/2.0/ai/agents/resetquota Reset agents' quota
ai_agents_update PUT /api/2.0/ai/agents/{id} Update an agent
ai_agents_update_quota PUT /api/2.0/ai/agents/agentquota Update agents' quota
AI::AssignmentsApi
ai_assignments_assign PUT /api/2.0/ai/assignments/assign Bind a profile to an action
ai_assignments_bulk_assign PUT /api/2.0/ai/assignments/bulk-assign Bulk assign
ai_assignments_cascade_profile_delete DELETE /api/2.0/ai/assignments/cascade-profile-delete Cascade profile delete
ai_assignments_get_all_assignments GET /api/2.0/ai/assignments/get-all-assignments Get all assignments
ai_assignments_get_assignment GET /api/2.0/ai/assignments/get-assignment Get assignment
ai_assignments_resolve_for_action GET /api/2.0/ai/assignments/resolve-for-action Resolve for action
ai_assignments_try_resolve_for_action GET /api/2.0/ai/assignments/try-resolve-for-action Try resolve for action
ai_assignments_unassign DELETE /api/2.0/ai/assignments/unassign Clear an action's profile
AI::AttachmentsApi
ai_attachments_delete DELETE /api/2.0/ai/attachments/delete Delete one attachment
ai_attachments_delete_many DELETE /api/2.0/ai/attachments/delete-many Delete many
ai_attachments_get POST /api/2.0/ai/attachments/get Get one attachment
ai_attachments_get_many POST /api/2.0/ai/attachments/get-many Get many
ai_attachments_get_suggested_questions POST /api/2.0/ai/attachments/suggested-questions Get suggested questions
ai_attachments_link_to_message POST /api/2.0/ai/attachments/link-to-message Link to message
ai_attachments_save_file POST /api/2.0/ai/attachments/save-file Save file
ai_attachments_save_files_many POST /api/2.0/ai/attachments/save-files-many Save files many
AI::ContextApi
ai_context_get_context_folders GET /api/2.0/ai/context/get-context-folders Get context folders
ai_context_get_room_skill GET /api/2.0/ai/context/get-room-skill Get room skill
ai_context_get_room_skills GET /api/2.0/ai/context/get-room-skills Get room skills
AI::EditorToolsApi
ai_editor_tools_call POST /api/2.0/ai/editor-tools/call Call an editor tool
ai_editor_tools_list GET /api/2.0/ai/editor-tools/list List editor tools
AI::ExportApi
ai_export_text_to_docx POST /api/2.0/ai/text-to-docx Start markdown export
AI::OpenAIPassthroughApi
ai_openai_chat_completions POST /api/2.0/ai/openai/{profileId}/v1/chat/completions OpenAI chat completions passthrough
ai_openai_images_generations POST /api/2.0/ai/openai/{profileId}/v1/images/generations OpenAI image generation passthrough
AI::PreferencesApi
ai_preferences_clear_deep_mode DELETE /api/2.0/ai/preferences/clear-deep-mode Clear deep mode
ai_preferences_get_deep_mode GET /api/2.0/ai/preferences/get-deep-mode Get deep mode
ai_preferences_get_reasoning_level GET /api/2.0/ai/preferences/get-reasoning-level Get reasoning level
ai_preferences_get_tool_permission_mode GET /api/2.0/ai/preferences/get-tool-permission-mode Get tool permission mode
ai_preferences_is_deep_mode_set GET /api/2.0/ai/preferences/is-deep-mode-set Is deep mode set
ai_preferences_set_deep_mode PUT /api/2.0/ai/preferences/set-deep-mode Set deep mode
ai_preferences_set_reasoning_level PUT /api/2.0/ai/preferences/set-reasoning-level Set reasoning level
ai_preferences_set_tool_permission_mode PUT /api/2.0/ai/preferences/set-tool-permission-mode Set tool permission mode
AI::ProfilesApi
ai_profiles_create POST /api/2.0/ai/profiles/create Create a provider profile
ai_profiles_delete DELETE /api/2.0/ai/profiles/delete Delete a provider profile
ai_profiles_get_by_id GET /api/2.0/ai/profiles/get-by-id Get a provider profile
ai_profiles_list GET /api/2.0/ai/profiles/list List provider profiles
ai_profiles_list_models GET /api/2.0/ai/profiles/list-models List models
ai_profiles_list_provider_models POST /api/2.0/ai/profiles/list-provider-models List provider models
ai_profiles_test_connection POST /api/2.0/ai/profiles/test-connection Test a profile's provider
ai_profiles_update PUT /api/2.0/ai/profiles/update Update a provider profile
AI::PromptsApi
ai_prompts_create POST /api/2.0/ai/prompts/create Save a prompt
ai_prompts_create_folder POST /api/2.0/ai/prompts/create-folder Create folder
ai_prompts_delete DELETE /api/2.0/ai/prompts/delete Delete a saved prompt
ai_prompts_delete_folder DELETE /api/2.0/ai/prompts/delete-folder Delete folder
ai_prompts_export GET /api/2.0/ai/prompts/export Export the prompt library
ai_prompts_get_by_id GET /api/2.0/ai/prompts/get-by-id Get a saved prompt
ai_prompts_get_folder_by_id GET /api/2.0/ai/prompts/get-folder-by-id Get a prompt folder
ai_prompts_import_bundle POST /api/2.0/ai/prompts/import-bundle Import bundle
ai_prompts_list GET /api/2.0/ai/prompts/list List saved prompts
ai_prompts_list_folders GET /api/2.0/ai/prompts/list-folders List folders
ai_prompts_move PUT /api/2.0/ai/prompts/move Move a prompt to a folder
ai_prompts_rename_folder PUT /api/2.0/ai/prompts/rename-folder Rename folder
ai_prompts_update PUT /api/2.0/ai/prompts/update Update a saved prompt
AI::SettingsApi
ai_settings_get GET /api/2.0/ai/config Get AI settings
ai_settings_get_tool_mode GET /api/2.0/ai/config/tool-mode Get the tool permission mode
ai_settings_get_user GET /api/2.0/ai/config/user Get user AI settings
ai_settings_get_vectorization GET /api/2.0/ai/config/vectorization Get vectorization settings
ai_settings_set_tool_mode PUT /api/2.0/ai/config/tool-mode Set the tool permission mode
ai_settings_set_user PUT /api/2.0/ai/config/user Update user AI settings
ai_settings_set_vectorization PUT /api/2.0/ai/config/vectorization Update vectorization settings
AI::ThreadsApi
ai_threads_append_user_message POST /api/2.0/ai/threads/append-user-message Append user message
ai_threads_clear_messages DELETE /api/2.0/ai/threads/clear-messages Clear messages
ai_threads_create POST /api/2.0/ai/threads/create Create a chat thread
ai_threads_delete DELETE /api/2.0/ai/threads/delete Delete a chat thread
ai_threads_delete_message DELETE /api/2.0/ai/threads/delete-message Delete message
ai_threads_get_by_id GET /api/2.0/ai/threads/get-by-id Get a chat thread
ai_threads_get_message_by_id GET /api/2.0/ai/threads/get-message-by-id Get one chat message
ai_threads_list GET /api/2.0/ai/threads/list List chat threads
ai_threads_open_or_create POST /api/2.0/ai/threads/open-or-create Open or create
ai_threads_read_messages GET /api/2.0/ai/threads/read-messages Read messages
ai_threads_regenerate_title POST /api/2.0/ai/threads/regenerate-title Regenerate title
ai_threads_rename PUT /api/2.0/ai/threads/rename Rename a chat thread
ai_threads_touch POST /api/2.0/ai/threads/touch Bump a thread's activity
ai_threads_update_message PUT /api/2.0/ai/threads/update-message Update message
AI::ToolsApi
ai_tools_add_custom_server POST /api/2.0/ai/tools/add-custom-server Add custom server
ai_tools_get_allow_always GET /api/2.0/ai/tools/get-allow-always Get allow always
ai_tools_get_custom_server GET /api/2.0/ai/tools/get-custom-server Get custom server
ai_tools_get_disabled GET /api/2.0/ai/tools/get-disabled Get disabled
ai_tools_is_allow_always GET /api/2.0/ai/tools/is-allow-always Is allow always
ai_tools_is_tool_disabled GET /api/2.0/ai/tools/is-tool-disabled Is tool disabled
ai_tools_list_custom_servers GET /api/2.0/ai/tools/list-custom-servers List custom servers
ai_tools_list_system_tools GET /api/2.0/ai/tools/list-system-tools List system tools
ai_tools_remove_custom_server DELETE /api/2.0/ai/tools/remove-custom-server Remove custom server
ai_tools_replace_all_custom_servers PUT /api/2.0/ai/tools/replace-all-custom-servers Replace all custom servers
ai_tools_set_allow_always PUT /api/2.0/ai/tools/set-allow-always Set allow always
ai_tools_set_disabled PUT /api/2.0/ai/tools/set-disabled Set disabled
ai_tools_update_custom_server PUT /api/2.0/ai/tools/update-custom-server Update custom server
AI::VectorizationApi
ai_vectorization_start_task POST /api/2.0/ai/vectorization/tasks Start a vectorization task
AI::WebSearchApi
ai_web_search_clear DELETE /api/2.0/ai/web-search/clear Clear the web-search configuration
ai_web_search_configure PUT /api/2.0/ai/web-search/configure Configure and verify web search
ai_web_search_get_active_config GET /api/2.0/ai/web-search/get-active-config Get active config
ai_web_search_is_configured GET /api/2.0/ai/web-search/is-configured Is configured
ai_web_search_passthrough_contents POST /api/2.0/ai/websearch/v1/contents Web page contents passthrough
ai_web_search_passthrough_search POST /api/2.0/ai/websearch/v1/search Web search passthrough
ai_web_search_set_active_config PUT /api/2.0/ai/web-search/set-active-config Set active config
ai_web_search_test_connection POST /api/2.0/ai/web-search/test-connection Test a web-search provider
ApiKeys
Method HTTP request Description
ApiKeys::ApiKeysApi
create_api_key POST /api/2.0/keys Create a user API key
delete_api_key DELETE /api/2.0/keys/{keyId} Delete an API key
get_all_permissions GET /api/2.0/keys/permissions Get API key permissions
get_api_key GET /api/2.0/keys/@self Get the current API key
get_api_keys GET /api/2.0/keys Get the API keys
update_api_key PUT /api/2.0/keys/{keyId} Update an API key
Apps
Method HTTP request Description
Apps::AppsApi
get GET /api/2.0/apps/{id} Get an app
get_all GET /api/2.0/apps Get all apps
get_settings GET /api/2.0/apps/{id}/settings Get app settings
set_enabled PUT /api/2.0/apps/{id}/enabled Enable or disable an app
set_settings PUT /api/2.0/apps/{id}/settings Save app settings
Authentication
Method HTTP request Description
Authentication::AuthenticationApi
authenticate_me POST /api/2.0/authentication Authenticate a user
authenticate_me_from_body_with_code POST /api/2.0/authentication/{code} Authenticate a user by code
check_confirm POST /api/2.0/authentication/confirm Check a confirmation link
get_is_authentificated GET /api/2.0/authentication Check authentication
logout POST /api/2.0/authentication/logout Log out
save_mobile_phone POST /api/2.0/authentication/setphone Set a mobile phone
send_sms_code POST /api/2.0/authentication/sendsms Send SMS code
Backup
Method HTTP request Description
Backup::BackupApi
cancel_backup POST /api/2.0/backup/cancelbackup Cancel the running backup
create_backup_schedule POST /api/2.0/backup/createbackupschedule Create the backup schedule
delete_backup DELETE /api/2.0/backup/deletebackup/{id} Delete the backup
delete_backup_history DELETE /api/2.0/backup/deletebackuphistory Delete the backup history
delete_backup_schedule DELETE /api/2.0/backup/deletebackupschedule Delete the backup schedule
get_backup_history GET /api/2.0/backup/getbackuphistory Get the backup history
get_backup_progress GET /api/2.0/backup/getbackupprogress Get the backup progress
get_backup_schedule GET /api/2.0/backup/getbackupschedule Get the backup schedule
get_backups_count GET /api/2.0/backup/getbackupscount Get the number of backups
get_backups_counts GET /api/2.0/backup/getbackupscountbypaid Get free and paid backup counts
get_backups_service_state GET /api/2.0/backup/getservicestate Check whether backups are enabled
get_restore_progress GET /api/2.0/backup/getrestoreprogress Get the restoring progress
start_backup POST /api/2.0/backup/startbackup Start the backup
start_backup_restore POST /api/2.0/backup/startrestore Start the restoring process
Capabilities
Method HTTP request Description
Capabilities::CapabilitiesApi
get_portal_capabilities GET /api/2.0/capabilities Get portal capabilities
Docs
Method HTTP request Description
Docs::DocsApi
convert_file POST /api/2.0/docs/converter Convert a file
run_builder_script POST /api/2.0/docs/builder Run a document builder script
Files
Method HTTP request Description
Files::FilesApi
add_file_to_recent POST /api/2.0/files/file/{fileId}/recent Add a file to Recent
add_templates POST /api/2.0/files/templates Add template files
change_version_history PUT /api/2.0/files/file/{fileId}/history Change version history
check_fill_form_draft POST /api/2.0/files/masterform/{fileId}/checkfillformdraft Open a form draft for filling
copy_file_as POST /api/2.0/files/file/{fileId}/copyas Copy a file
create_edit_session POST /api/2.0/files/file/{fileId}/edit_session Create the editing session
create_file POST /api/2.0/files/{folderId}/file Create a file
create_file_in_my_documents POST /api/2.0/files/@my/file Create a file in My documents
create_file_primary_external_link POST /api/2.0/files/file/{id}/link Create the file primary external link
create_html_file POST /api/2.0/files/{folderId}/html Create an HTML file
create_html_file_in_my_documents POST /api/2.0/files/@my/html Create an HTML file in My documents
create_text_file POST /api/2.0/files/{folderId}/text Create a text file
create_text_file_in_my_documents POST /api/2.0/files/@my/text Create a text file in My documents
create_thumbnails POST /api/2.0/files/thumbnails Queue file thumbnails
delete_file DELETE /api/2.0/files/file/{fileId} Delete a file
delete_recent DELETE /api/2.0/files/recent Delete recent files
delete_templates DELETE /api/2.0/files/templates Delete template files
generate_xlsx POST /api/2.0/files/file/{fileId}/xlsx Generate a form answers report
get_all_form_roles GET /api/2.0/files/file/{fileId}/formroles Get form roles
get_edit_diff_url GET /api/2.0/files/file/{fileId}/edit/diff Get changes URL
get_edit_history GET /api/2.0/files/file/{fileId}/edit/history Get version history
get_encryption_info GET /api/2.0/files/{fileId}/access Get file encryption information
get_file_history GET /api/2.0/files/file/{fileId}/log Get file history
get_file_info GET /api/2.0/files/file/{fileId} Get file information
get_file_links GET /api/2.0/files/file/{id}/links Get file external links
get_file_primary_external_link GET /api/2.0/files/file/{id}/link Get the file primary external link
get_file_version_info GET /api/2.0/files/file/{fileId}/history Get file versions
get_fill_result GET /api/2.0/files/file/fillresult Get form-filling result
get_form_submissions GET /api/2.0/files/file/{fileId}/submissions Get form submission results
get_presigned_file_uri GET /api/2.0/files/file/{fileId}/presigned Get a signed download address
get_presigned_uri GET /api/2.0/files/file/{fileId}/presigneduri Get file download link
get_protected_file_users GET /api/2.0/files/file/{fileId}/protectusers Get users for document protection
get_reference_data POST /api/2.0/files/file/referencedata Resolve a spreadsheet reference
get_xlsx GET /api/2.0/files/file/{fileId}/xlsx Get form report generation status
is_form_pdf GET /api/2.0/files/file/{fileId}/isformpdf Check the PDF file
lock_file PUT /api/2.0/files/file/{fileId}/lock Lock a file
manage_form_filling PUT /api/2.0/files/file/{fileId}/manageformfilling Perform form filling action
open_edit_file GET /api/2.0/files/file/{fileId}/openedit Get the editor configuration
restore_file_version POST /api/2.0/files/file/{fileId}/restoreversion Restore a file version
save_editing_file_from_form PUT /api/2.0/files/file/{fileId}/saveediting Save edited file content
save_file_as_pdf POST /api/2.0/files/file/{id}/saveaspdf Save a file as PDF
save_form_role_mapping POST /api/2.0/files/file/{fileId}/formrolemapping Save form role mapping
set_custom_filter_tag PUT /api/2.0/files/file/{fileId}/customfilter Set the Custom Filter editing mode
set_encryption_info PUT /api/2.0/files/{fileId}/access Set file encryption information
set_file_external_link PUT /api/2.0/files/file/{id}/links Set a file external link
set_file_order PUT /api/2.0/files/{fileId}/order Set file order
set_files_order PUT /api/2.0/files/order Set order of files
start_edit_file POST /api/2.0/files/file/{fileId}/startedit Open an editing session
start_filling_file PUT /api/2.0/files/file/{fileId}/startfilling Start filling a form
toggle_file_favorite GET /api/2.0/files/favorites/{fileId} Set the file favorite status
track_edit_file GET /api/2.0/files/file/{fileId}/trackeditfile Track an editing session
update_file PUT /api/2.0/files/file/{fileId} Update a file
Files::FoldersApi
check_upload POST /api/2.0/files/{folderId}/upload/check Check for upload conflicts
create_folder POST /api/2.0/files/folder/{folderId} Create a folder
create_folder_primary_external_link POST /api/2.0/files/folder/{id}/link Create the folder primary external link
create_report_folder_history POST /api/2.0/files/folder/{folderId}/log/report Start the folder history report generation
delete_folder DELETE /api/2.0/files/folder/{folderId} Delete a folder
generate_xlsx_by_folder POST /api/2.0/files/folder/{folderId}/xlsx Generate XLSX report by folder
get_favorites_folder GET /api/2.0/files/@favorites Get the Favorites section
get_files_used_space GET /api/2.0/files/filesusedspace Get used space of files
get_folder GET /api/2.0/files/{folderId}/formfilter Get folder form filter
get_folder_by_folder_id GET /api/2.0/files/{folderId} Get a folder by ID
get_folder_history GET /api/2.0/files/folder/{folderId}/log Get folder history
get_folder_info GET /api/2.0/files/folder/{folderId} Get folder information
get_folder_links GET /api/2.0/files/folder/{id}/links Get folder external links
get_folder_path GET /api/2.0/files/folder/{folderId}/path Get the folder path
get_folder_primary_external_link GET /api/2.0/files/folder/{id}/link Get the folder primary external link
get_folders GET /api/2.0/files/{folderId}/subfolders Get subfolders
get_forms_folder GET /api/2.0/files/@forms Get the Forms section
get_my_folder GET /api/2.0/files/@my Get the My documents section
get_new_folder_items GET /api/2.0/files/{folderId}/news Get new folder items
get_recent_folder GET /api/2.0/files/recent Get the Recent section
get_report_folder_history GET /api/2.0/files/folder/{folderId}/log/report Get the folder history report generation status
get_root_folders GET /api/2.0/files/@root Get filtered sections
get_trash_folder GET /api/2.0/files/@trash Get the Trash section
insert_file POST /api/2.0/files/{folderId}/insert Insert a file
insert_file_to_my_from_body POST /api/2.0/files/@my/insert Insert a file into My documents
rename_folder PUT /api/2.0/files/folder/{folderId} Rename a folder
search_folder POST /api/2.0/files/{folderId}/search Search a folder by metadata
set_folder_order PUT /api/2.0/files/folder/{folderId}/order Set folder order
set_folder_primary_external_link PUT /api/2.0/files/folder/{id}/links Set the folder external link
terminate_report_folder_history DELETE /api/2.0/files/folder/{folderId}/log/report Terminate the folder history report generation
upload_file POST /api/2.0/files/{folderId}/upload Upload a file
upload_file_to_my POST /api/2.0/files/@my/upload Upload a file to My documents
Files::MetadataApi
assign_file_templates PUT /api/2.0/files/metadata/file/{fileId}/templates Assign templates to a file
assign_folder_templates PUT /api/2.0/files/metadata/folder/{folderId}/templates Assign templates to a folder
create_field POST /api/2.0/files/metadata/templates/{templateId}/fields Add a metadata field
create_template POST /api/2.0/files/metadata/templates Create a metadata template
delete_field DELETE /api/2.0/files/metadata/templates/{templateId}/fields/{fieldId} Delete a metadata field
delete_template DELETE /api/2.0/files/metadata/templates/{templateId} Delete a metadata template
get_cascade_progress GET /api/2.0/files/metadata/folder/{folderId}/templates/progress Get cascade progress
get_file_metadata GET /api/2.0/files/metadata/file/{fileId} Get file metadata
get_folder_metadata GET /api/2.0/files/metadata/folder/{folderId} Get folder metadata
get_template GET /api/2.0/files/metadata/templates/{templateId} Get a metadata template
get_templates GET /api/2.0/files/metadata/templates Get metadata templates
set_file_custom_fields PUT /api/2.0/files/metadata/file/{fileId}/customfields Set file custom fields
set_file_values PUT /api/2.0/files/metadata/file/{fileId}/values Set file metadata values
set_folder_custom_fields PUT /api/2.0/files/metadata/folder/{folderId}/customfields Set folder custom fields
set_folder_values PUT /api/2.0/files/metadata/folder/{folderId}/values Set folder metadata values
unassign_file_template DELETE /api/2.0/files/metadata/file/{fileId}/templates/{templateId} Unassign a template from a file
unassign_folder_template DELETE /api/2.0/files/metadata/folder/{folderId}/templates/{templateId} Unassign a template from a folder
update_field PUT /api/2.0/files/metadata/templates/{templateId}/fields/{fieldId} Update a metadata field
update_folder_template PUT /api/2.0/files/metadata/folder/{folderId}/templates/{templateId} Update a template assignment on a folder
update_template PUT /api/2.0/files/metadata/templates/{templateId} Update a metadata template
Files::OperationsApi
abort_upload_session DELETE /api/2.0/files/{folderId}/session/{sessionId} Abort an upload session
add_favorites POST /api/2.0/files/favorites Add favorite files and folders
bulk_download PUT /api/2.0/files/fileops/bulkdownload Bulk download
check_conversion_status GET /api/2.0/files/file/{fileId}/checkconversion Get conversion status
check_move_or_copy_batch_items GET /api/2.0/files/fileops/move Check move or copy conflicts
check_move_or_copy_dest_folder GET /api/2.0/files/fileops/checkdestfolder Check the destination folder
copy_batch_items PUT /api/2.0/files/fileops/copy Copy files and folders
create_upload_session POST /api/2.0/files/{folderId}/upload/create_session Chunked upload
create_upload_session_in_folder POST /api/2.0/files/{folderId}/session Create an upload session
delete_batch_items PUT /api/2.0/files/fileops/delete Delete files and folders
delete_favorites_from_body DELETE /api/2.0/files/favorites Delete favorite files and folders
delete_file_versions PUT /api/2.0/files/fileops/deleteversion Delete file versions
duplicate_batch_items PUT /api/2.0/files/fileops/duplicate Duplicate files and folders
empty_trash PUT /api/2.0/files/fileops/emptytrash Empty the Trash folder
finalize_session PUT /api/2.0/files/{folderId}/session/{sessionId}/finalize Finalize an upload session
get_operation_statuses GET /api/2.0/files/fileops Get active file operations
get_operation_statuses_by_type GET /api/2.0/files/fileops/{operationType} Get file operations by type
mark_as_read PUT /api/2.0/files/fileops/markasread Mark files and folders as read
move_batch_items PUT /api/2.0/files/fileops/move Move files and folders
start_file_conversion PUT /api/2.0/files/file/{fileId}/checkconversion Start file conversion
terminate_tasks PUT /api/2.0/files/fileops/terminate/{id} Cancel file operations
update_file_comment PUT /api/2.0/files/file/{fileId}/comment Update a comment
upload_async_session POST /api/2.0/files/{folderId}/session/{sessionId}/upload Upload a numbered chunk
upload_session POST /api/2.0/files/{folderId}/session/{sessionId} Upload the next chunk
Files::QuotaApi
reset_room_quota PUT /api/2.0/files/rooms/resetquota Reset the room quota limit
update_rooms_quota PUT /api/2.0/files/rooms/roomquota Change the room quota limit
Files::SettingsApi
change_access_to_thirdparty PUT /api/2.0/files/thirdparty Change the third-party settings access
change_automatically_clean_up PUT /api/2.0/files/settings/autocleanup Update the trash bin auto-clearing setting
change_default_access_rights PUT /api/2.0/files/settings/dafaultaccessrights Change the default access rights
change_delete_confirm PUT /api/2.0/files/changedeleteconfrim Ask for delete confirmation
change_download_zip PUT /api/2.0/files/settings/downloadtargz Change the download archive format
change_external_sharing_settings PUT /api/2.0/files/settings/externalsharingsettings Configure external sharing
check_doc_service_url PUT /api/2.0/files/docservice Set the document service address
display_file_extension PUT /api/2.0/files/displayfileextension Display a file extension
display_recent PUT /api/2.0/files/displayrecent Show the Recent section
external_share PUT /api/2.0/files/settings/external Change the external sharing ability
external_share_social_media PUT /api/2.0/files/settings/externalsocialmedia Change the external sharing ability on social networks
forcesave PUT /api/2.0/files/forcesave Change the forcesaving ability
get_automatically_clean_up GET /api/2.0/files/settings/autocleanup Get the trash bin auto-clearing setting
get_default_templates GET /api/2.0/files/settings/defaulttemplate Get the default template setting
get_doc_service_url GET /api/2.0/files/docservice Get the document service address
get_files_module GET /api/2.0/files/info Get the Documents module information
get_files_settings GET /api/2.0/files/settings Get file settings
hide_confirm_cancel_operation PUT /api/2.0/files/hideconfirmcanceloperation Hide confirmation dialog when canceling operations
hide_confirm_convert PUT /api/2.0/files/hideconfirmconvert Hide the confirmation dialog when converting
hide_confirm_room_lifetime PUT /api/2.0/files/hideconfirmroomlifetime Hide confirmation dialog when changing room lifetime settings
keep_new_file_name PUT /api/2.0/files/keepnewfilename Keep the default file name
reset_default_template DELETE /api/2.0/files/settings/defaulttemplate Reset the default template setting
set_default_template PUT /api/2.0/files/settings/defaulttemplate Change the default template setting
set_open_editor_in_same_tab PUT /api/2.0/files/settings/openeditorinsametab Open document in the same browser tab
set_organize_rooms_grouping PUT /api/2.0/files/settings/organizegrouping Organize rooms grouping
show_quick_actions PUT /api/2.0/files/showquickactions Display quick actions
store_forcesave PUT /api/2.0/files/storeforcesave Change the ability to store the forcesaved files
store_original PUT /api/2.0/files/storeoriginal Change the ability to upload original formats
update_file_if_exist PUT /api/2.0/files/updateifexist Update a file version if it exists
upload_default_template POST /api/2.0/files/settings/defaulttemplate Upload a file as the default template setting
Files::SharingApi
apply_external_share_password POST /api/2.0/files/share/{key}/password Unlock a password-protected link
change_file_owner POST /api/2.0/files/owner Change the room or file owner
get_encryption_access GET /api/2.0/files/file/{fileId}/publickeys Get file encryption keys
get_external_share_data GET /api/2.0/files/share/{key} Resolve an external share link
get_file_security_info GET /api/2.0/files/file/{id}/share Get file sharing rights
get_folder_security_info GET /api/2.0/files/folder/{id}/share Get folder sharing rights
get_groups_members_with_file_security GET /api/2.0/files/file/{fileId}/group/{groupId}/share Get file access of group members
get_groups_members_with_folder_security GET /api/2.0/files/folder/{folderId}/group/{groupId}/share Get folder access of group members
get_security_info POST /api/2.0/files/share Get sharing rights in batch
get_shared_users GET /api/2.0/files/file/{fileId}/sharedusers Get users to mention in a file
remove_security_info DELETE /api/2.0/files/share Remove sharing rights in batch
send_editor_notify POST /api/2.0/files/file/{fileId}/sendeditornotify Notify mentioned users
set_file_security_info PUT /api/2.0/files/file/{id}/share Share a file
set_folder_security_info PUT /api/2.0/files/folder/{id}/share Share a folder
set_security_info PUT /api/2.0/files/share Set sharing rights in batch
Files::ThirdPartyIntegrationApi
delete_third_party DELETE /api/2.0/files/thirdparty/{providerId} Remove a third-party account
get_all_providers GET /api/2.0/files/thirdparty/providers Get all third-party providers
get_backup_third_party_account GET /api/2.0/files/thirdparty/backup Get the third-party backup folder
get_capabilities GET /api/2.0/files/thirdparty/capabilities Get third-party provider capabilities
get_common_third_party_folders GET /api/2.0/files/thirdparty/common Get common third-party folders
get_third_party_accounts GET /api/2.0/files/thirdparty Get the third-party accounts
save_third_party POST /api/2.0/files/thirdparty Connect a third-party account
save_third_party_backup POST /api/2.0/files/thirdparty/backup Connect the third-party backup storage
Group
Method HTTP request Description
Group::GroupApi
add_group POST /api/2.0/group Add a new group
add_members_to PUT /api/2.0/group/{id}/members Add group members
delete_group DELETE /api/2.0/group/{id} Delete a group
get_group GET /api/2.0/group/{id} Get a group
get_group_by_user_id GET /api/2.0/group/user/{userId} Get user groups
get_groups GET /api/2.0/group Get groups
move_members_to PUT /api/2.0/group/{fromId}/members/{toId} Move group members
remove_members_from DELETE /api/2.0/group/{id}/members Remove group members
set_group_manager PUT /api/2.0/group/{id}/manager Set a group manager
set_members_to POST /api/2.0/group/{id}/members Replace group members
update_group PUT /api/2.0/group/{id} Update a group
Group::SearchApi
get_groups_with_files_shared GET /api/2.0/group/file/{id} Search groups for a file
get_groups_with_folders_shared GET /api/2.0/group/folder/{id} Search groups for a folder
get_groups_with_rooms_shared GET /api/2.0/group/room/{id} Search groups for a room
Migration
Method HTTP request Description
Migration::MigrationApi
cancel_migration POST /api/2.0/migration/cancel Cancel migration
clear_migration POST /api/2.0/migration/clear Clear migration
finish_migration POST /api/2.0/migration/finish Finish migration
get_migration_logs GET /api/2.0/migration/logs Get migration logs
get_migration_status GET /api/2.0/migration/status Get migration status
list_migrations GET /api/2.0/migration/list Get available migrators
start_migration POST /api/2.0/migration/migrate Start migration
upload_and_initialize_migration POST /api/2.0/migration/init/{migratorName} Parse migration archive
OAuth20
Method HTTP request Description
OAuth20::AuthorizationApi
authorize_o_auth GET /oauth2/authorize Start the authorization flow
exchange_token POST /oauth2/token Exchange the authorization code
submit_consent POST /oauth2/authorize Submit the consent decision
OAuth20::ClientManagementApi
change_activation PATCH /api/2.0/oauth2/clients/{clientId}/activation Change client activation status
create_client POST /api/2.0/oauth2/clients Create a new OAuth2 client
delete_client DELETE /api/2.0/oauth2/clients/{clientId} Delete an OAuth2 client
delete_tenant_clients DELETE /api/2.0/oauth2/clients/tenant Delete all tenant OAuth2 clients
delete_user_clients DELETE /api/2.0/oauth2/clients Delete all user OAuth2 clients
regenerate_secret PATCH /api/2.0/oauth2/clients/{clientId}/regenerate Regenerate client secret
revoke_user_client DELETE /api/2.0/oauth2/clients/{clientId}/revoke Revoke client consent
update_client PUT /api/2.0/oauth2/clients/{clientId} Update an existing OAuth2 client
OAuth20::ClientQueryingApi
get_client GET /api/2.0/oauth2/clients/{clientId} Get client details
get_client_info GET /api/2.0/oauth2/clients/{clientId}/info Get client info
get_clients GET /api/2.0/oauth2/clients List clients
get_clients_info GET /api/2.0/oauth2/clients/info List client info
get_consents GET /api/2.0/oauth2/clients/consents List user consents
get_public_client_info GET /api/2.0/oauth2/clients/{clientId}/public/info Get public client info
OAuth20::DiscoveryApi
handle_options OPTIONS /.well-known/oauth-authorization-server Probe the discovery endpoint
OAuth20::ScopeManagementApi
get_scopes GET /api/2.0/oauth2/scopes List available OAuth2 scopes
People
Method HTTP request Description
People::EmailApi
change_user_email PUT /api/2.0/people/{userId}/email Change a user email
send_email_change_instructions POST /api/2.0/people/email Send instructions to change email
People::GuestsApi
approve_guest_share_link POST /api/2.0/people/guests/share/approve Approve a guest sharing link
delete_guests DELETE /api/2.0/people/guests Remove guest relations
People::PasswordApi
change_user_password PUT /api/2.0/people/{userId}/password Change a user password
send_user_password POST /api/2.0/people/password Remind a user password
People::PhotosApi
create_member_photo_thumbnails POST /api/2.0/people/{userId}/photo/thumbnails Create photo thumbnails
delete_member_photo DELETE /api/2.0/people/{userId}/photo Delete a user photo
get_member_photo GET /api/2.0/people/{userId}/photo Get a user photo
update_member_photo PUT /api/2.0/people/{userId}/photo Update a user photo
upload_member_photo POST /api/2.0/people/{userId}/photo Upload a user photo
People::ProfilesApi
add_member POST /api/2.0/people Add a user
check_user_exists_by_email GET /api/2.0/people/exists Check whether an email is taken
delete_member DELETE /api/2.0/people/{userId} Delete a user
delete_profile DELETE /api/2.0/people/@self Close my own profile
get_all_profiles GET /api/2.0/people Get the active profiles
get_claims GET /api/2.0/people/tokendiagnostics Get user claims
get_profile_by_email GET /api/2.0/people/email Get a profile by user email
get_profile_by_user_id GET /api/2.0/people/{userId} Get a profile by user ID
get_self_profile GET /api/2.0/people/@self Get my profile
invite_users POST /api/2.0/people/invite Invite users
remove_users PUT /api/2.0/people/delete Delete users
resend_user_invites PUT /api/2.0/people/invite Resend activation emails
update_member PUT /api/2.0/people/{userId} Update a user
update_member_culture PUT /api/2.0/people/{userId}/culture Update a user culture
People::QuotaApi
reset_users_quota PUT /api/2.0/people/resetquota Reset a user quota limit
update_user_quota PUT /api/2.0/people/userquota Change a user quota limit
People::SearchApi
get_accounts_entries_with_files_shared GET /api/2.0/accounts/file/{id}/search Search accounts for a file
get_accounts_entries_with_folders_shared GET /api/2.0/accounts/folder/{id}/search Search accounts for a folder
get_accounts_entries_with_rooms_shared GET /api/2.0/accounts/room/{id}/search Search accounts for a room
get_search GET /api/2.0/people/@search/{query} Search users
get_simple_by_filter GET /api/2.0/people/simple/filter Filter users in brief
get_users_with_files_shared GET /api/2.0/people/file/{id} Search users for a file
get_users_with_folders_shared GET /api/2.0/people/folder/{id} Search users for a folder
get_users_with_room_shared GET /api/2.0/people/room/{id} Search users for a room
search_users_by_extended_filter GET /api/2.0/people/filter Filter users in detail
search_users_by_query GET /api/2.0/people/search Search users by query
search_users_by_status GET /api/2.0/people/status/{status}/search Search users by status filter
People::ThemeApi
change_portal_theme PUT /api/2.0/people/theme Change the portal theme
get_portal_theme GET /api/2.0/people/theme Get the portal theme
People::ThirdPartyAccountsApi
get_third_party_auth_providers GET /api/2.0/people/thirdparty/providers Get third-party providers
link_third_party_account PUT /api/2.0/people/thirdparty/linkaccount Link a third-party account
signup_third_party_account POST /api/2.0/people/thirdparty/signup Sign up with a provider
unlink_third_party_account DELETE /api/2.0/people/thirdparty/unlinkaccount Unlink a third-party account
People::UserDataApi
get_delete_personal_folder_progress GET /api/2.0/people/delete/personal/progress Get the personal folder deletion progress
get_reassign_progress GET /api/2.0/people/reassign/progress/{userId} Get the reassignment progress
get_remove_progress GET /api/2.0/people/remove/progress/{userId} Get the deletion progress
necessary_reassign GET /api/2.0/people/reassign/necessary Check data for reassignment need
send_instructions_to_delete PUT /api/2.0/people/self/delete Send the deletion instructions
start_delete_personal_folder POST /api/2.0/people/delete/personal/start Delete the personal folder
start_reassign POST /api/2.0/people/reassign/start Start the data reassignment
start_remove POST /api/2.0/people/remove/start Start the data deletion
terminate_reassign PUT /api/2.0/people/reassign/terminate Terminate the data reassignment
terminate_remove PUT /api/2.0/people/remove/terminate Terminate the data deletion
People::UserStatusApi
get_by_status GET /api/2.0/people/status/{status} Get profiles by status
update_user_activation_status PUT /api/2.0/people/activationstatus/{activationStatus} Set my activation status
update_user_status PUT /api/2.0/people/status/{status} Change a user status
People::UserTypeApi
get_user_type_update_progress GET /api/2.0/people/type/progress/{userId} Get the user type change progress
start_user_type_update POST /api/2.0/people/type Start updating user type
terminate_user_type_update PUT /api/2.0/people/type/terminate Terminate updating user type
update_user_type PUT /api/2.0/people/type/{type} Change a user type
Portal
Method HTTP request Description
Portal::GuestsApi
get_guest_sharing_link GET /api/2.0/people/guests/{userId}/share Get a guest sharing link
Portal::PaymentApi
calculate_wallet_payment PUT /api/2.0/portal/payment/calculatewallet Calculate the wallet payment amount
change_tenant_wallet_service_state POST /api/2.0/portal/payment/servicestate Switch a wallet service
create_customer_monthly_usage_report POST /api/2.0/portal/payment/customer/usage/monthly/report Start the monthly usage report
create_customer_operations_report POST /api/2.0/portal/payment/customer/operationsreport Start the operations report
create_customer_service_usage_report POST /api/2.0/portal/payment/customer/usage/report Start the service usage report
get_accounting_service_prices GET /api/2.0/portal/payment/accounting/prices/{serviceName} Get the service prices from the accounting service
get_active_services GET /api/2.0/portal/payment/activeservices Get the active wallet services
get_ai_prices GET /api/2.0/portal/payment/ai-prices Get AI model prices
get_checkout_setup_url GET /api/2.0/portal/payment/checkoutsetupurl Get the checkout setup page URL
get_customer_balance GET /api/2.0/portal/payment/customer/balance Get the customer balance
get_customer_info GET /api/2.0/portal/payment/customerinfo Get the customer information
get_customer_monthly_usage GET /api/2.0/portal/payment/customer/usage/monthly Get the customer monthly usage
get_customer_monthly_usage_report GET /api/2.0/portal/payment/customer/usage/monthly/report Get the monthly usage report status
get_customer_operations GET /api/2.0/portal/payment/customer/operations Get the wallet operations
get_customer_operations_report GET /api/2.0/portal/payment/customer/operationsreport Get the operations report status
get_customer_service_usage GET /api/2.0/portal/payment/customer/usage Get the customer service usage
get_customer_service_usage_report GET /api/2.0/portal/payment/customer/usage/report Get the service usage report status
get_payment_account GET /api/2.0/portal/payment/account Get the billing account page
get_payment_currencies GET /api/2.0/portal/payment/currencies Get the billing currencies
get_payment_quotas GET /api/2.0/portal/payment/quotas Get the purchasable quotas
get_payment_url PUT /api/2.0/portal/payment/url Get the payment page URL
get_portal_prices GET /api/2.0/portal/payment/prices Get the product prices
get_quota_payment_information GET /api/2.0/portal/payment/quota Get the current plan and limits
get_restricted_ai_models GET /api/2.0/portal/payment/ai-model/restrictions Get restricted AI models
get_subscription_balance_info GET /api/2.0/portal/payment/subscription/balance Get the subscription balance information
get_tenant_wallet_service_settings GET /api/2.0/portal/payment/servicessettings Get the wallet service settings
get_tenant_wallet_settings GET /api/2.0/portal/payment/topupsettings Get the auto top-up settings
get_wallet_service GET /api/2.0/portal/payment/walletservice Get a wallet service
get_wallet_services GET /api/2.0/portal/payment/walletservices Get wallet services
move_subscription_to_wallet POST /api/2.0/portal/payment/subscription/movetowallet Move the subscription to the wallet
send_payment_request POST /api/2.0/portal/payment/request Contact the sales team
set_restricted_ai_models PUT /api/2.0/portal/payment/ai-model/restrictions Set restricted AI models
set_tenant_wallet_settings POST /api/2.0/portal/payment/topupsettings Set the auto top-up settings
terminate_customer_monthly_usage_report DELETE /api/2.0/portal/payment/customer/usage/monthly/report Terminate the monthly usage report
terminate_customer_operations_report DELETE /api/2.0/portal/payment/customer/operationsreport Terminate the operations report
terminate_customer_service_usage_report DELETE /api/2.0/portal/payment/customer/usage/report Terminate the service usage report
top_up_deposit POST /api/2.0/portal/payment/deposit Top up the wallet
update_payment PUT /api/2.0/portal/payment/update Change the subscription quantity
update_wallet_payment PUT /api/2.0/portal/payment/updatewallet Change a wallet service quantity
Portal::QuotaApi
get_portal_quota GET /api/2.0/portal/quota Get the portal quota
get_portal_tariff GET /api/2.0/portal/tariff Get the portal tariff
get_portal_used_space GET /api/2.0/portal/usedspace Get the portal used space
get_right_quota GET /api/2.0/portal/quota/right Get the recommended quota
get_upcoming_payments GET /api/2.0/portal/tariff/upcoming Get upcoming payments
Portal::SettingsApi
continue_portal PUT /api/2.0/portal/continue Restore a portal
delete_portal DELETE /api/2.0/portal/delete Delete a portal
get_portal_information GET /api/2.0/portal Get portal information
get_portal_path GET /api/2.0/portal/path Get a path to the portal
send_delete_instructions POST /api/2.0/portal/delete Send removal instructions
send_suspend_instructions POST /api/2.0/portal/suspend Send suspension instructions
suspend_portal PUT /api/2.0/portal/suspend Deactivate a portal
unblock_portal PUT /api/2.0/portal/unblock Unblock a portal
Portal::UsersApi
create_invitation_link POST /api/2.0/portal/users/invitationlink Create an invitation link
delete_invitation_link DELETE /api/2.0/portal/users/invitationlink Delete an invitation link
get_invitation_link GET /api/2.0/portal/users/invite/{employeeType} Get a legacy invitation link
get_invitation_link_by_employee_type GET /api/2.0/portal/users/invitationlink/{employeeType} Get an invitation link by role
get_portal_users_count GET /api/2.0/portal/userscount Get a number of portal users
get_user_by_id GET /api/2.0/portal/users/{userId} Get a portal user
mark_gift_message_as_read POST /api/2.0/portal/present/mark Mark a gift message as read
send_congratulations POST /api/2.0/portal/sendcongratulations Send congratulations
update_invitation_link PUT /api/2.0/portal/users/invitationlink Update an invitation link
Rooms
Method HTTP request Description
Rooms::RoomsApi
add_room_tags PUT /api/2.0/files/rooms/{id}/tags Attach tags to a room
archive_room PUT /api/2.0/files/rooms/{id}/archive Archive a room
change_room_cover POST /api/2.0/files/rooms/{id}/cover Change the room cover
create_room POST /api/2.0/files/rooms Create a room
create_room_from_template POST /api/2.0/files/rooms/fromtemplate Create a room from the template
create_room_logo POST /api/2.0/files/rooms/{id}/logo Set the room logo
create_room_tag POST /api/2.0/files/tags Create a room tag
create_room_template POST /api/2.0/files/roomtemplate Create a room template
create_room_third_party POST /api/2.0/files/rooms/thirdparty/{id} Create a third-party room
delete_custom_tags DELETE /api/2.0/files/tags Delete the custom room tags
delete_room DELETE /api/2.0/files/rooms/{id} Remove a room
delete_room_logo DELETE /api/2.0/files/rooms/{id}/logo Remove a room logo
delete_room_tags DELETE /api/2.0/files/rooms/{id}/tags Detach tags from a room
get_external_db_sync_status GET /api/2.0/files/rooms/{id}/externaldbsync Get external DB sync status
get_new_room_items GET /api/2.0/files/rooms/{id}/news Get new items in a room
get_public_settings GET /api/2.0/files/roomtemplate/{id}/public Get room template public access
get_room_ai_folder GET /api/2.0/files/rooms/{id}/ai Get the .ai folder of a room
get_room_covers GET /api/2.0/files/rooms/covers Get room cover gallery
get_room_creating_status GET /api/2.0/files/rooms/fromtemplate/status Get the room creation progress
get_room_index_export GET /api/2.0/files/rooms/indexexport Get the room index export
get_room_info GET /api/2.0/files/rooms/{id} Get room information
get_room_links GET /api/2.0/files/rooms/{id}/links Get the room links
get_room_security_info GET /api/2.0/files/rooms/{id}/share Get the room access rights
get_room_tags_info GET /api/2.0/files/tags Get available room tags
get_room_template_creating_status GET /api/2.0/files/roomtemplate/status Get room template creation status
get_rooms_folder GET /api/2.0/files/rooms Get rooms
get_rooms_new_items GET /api/2.0/files/rooms/news Get new items in all rooms
get_rooms_primary_external_link GET /api/2.0/files/rooms/{id}/link Get the room primary external link
has_tag_links GET /api/2.0/files/tags/{tagName}/haslinks Check room tag usage
pin_room PUT /api/2.0/files/rooms/{id}/pin Pin a room
reorder_room PUT /api/2.0/files/rooms/{id}/reorder Reorder room contents
resend_email_invitations POST /api/2.0/files/rooms/{id}/resend Resend the room invitations
search_rooms POST /api/2.0/files/rooms/search Search the rooms by metadata
set_public_settings PUT /api/2.0/files/roomtemplate/public Set room template public access
set_room_link PUT /api/2.0/files/rooms/{id}/links Set the room external or invitation link
set_room_security PUT /api/2.0/files/rooms/{id}/share Set the room access rights
start_external_db_sync POST /api/2.0/files/rooms/{id}/externaldbsync Start external DB sync
start_room_index_export POST /api/2.0/files/rooms/{id}/indexexport Start the room index export
terminate_room_index_export DELETE /api/2.0/files/rooms/indexexport Terminate the room index export
unarchive_room PUT /api/2.0/files/rooms/{id}/unarchive Unarchive a room
unpin_room PUT /api/2.0/files/rooms/{id}/unpin Unpin a room
update_room PUT /api/2.0/files/rooms/{id} Update a room
update_room_tag PUT /api/2.0/files/tags Rename a room tag
upload_room_logo POST /api/2.0/files/logos Upload a room logo image
Rooms::GroupsApi
add_room_group POST /api/2.0/files/group Add a new room group
change_room_group_icon POST /api/2.0/files/group/{id}/icon Change room group icon
delete_room_group DELETE /api/2.0/files/group/{id} Delete a room group
get_room_group_info GET /api/2.0/files/group/{id} Get room group info
get_room_groups GET /api/2.0/files/group List room groups
update_room_group PUT /api/2.0/files/group/{id} Update room group
Rooms::PrivacyRoomApi
delete_keys DELETE /api/2.0/privacyroom/keys/{id} Delete an encryption key
get_user_keys GET /api/2.0/privacyroom/keys Get own encryption keys
get_user_keys_for_room GET /api/2.0/privacyroom/{roomId}/access Get private room access keys
replace_key PUT /api/2.0/privacyroom/keys Rotate an encryption key
set_keys POST /api/2.0/privacyroom/keys Create an encryption key
Security
Method HTTP request Description
Security::AccessToDevToolsApi
set_tenant_dev_tools_access_settings POST /api/2.0/settings/devtoolsaccess Set the Developer Tools access settings
Security::ActiveConnectionsApi
get_all_active_connections GET /api/2.0/security/activeconnections Get active connections
log_out_active_connection PUT /api/2.0/security/activeconnections/logout/{loginEventId} Log out one connection
log_out_all_active_connections_change_password PUT /api/2.0/security/activeconnections/logoutallchangepassword Log out and reset password
log_out_all_active_connections_for_user PUT /api/2.0/security/activeconnections/logoutall/{userId} Log out a user everywhere
log_out_all_except_this_connection PUT /api/2.0/security/activeconnections/logoutallexceptthis Log out other connections
Security::AuditTrailDataApi
create_audit_trail_report POST /api/2.0/security/audit/events/report Start audit trail report
get_audit_events_by_filter GET /api/2.0/security/audit/events/filter Get filtered audit events
get_audit_settings GET /api/2.0/security/audit/settings/lifetime Get audit lifetime settings
get_audit_trail_mappers GET /api/2.0/security/audit/mappers Get audit trail mappers
get_audit_trail_report GET /api/2.0/security/audit/events/report Get audit trail report status
get_audit_trail_types GET /api/2.0/security/audit/types Get audit trail types
get_last_audit_events GET /api/2.0/security/audit/events/last Get recent audit events
set_audit_settings POST /api/2.0/security/audit/settings/lifetime Set audit lifetime settings
terminate_audit_trail_report DELETE /api/2.0/security/audit/events/report Terminate audit trail report
Security::BannersVisibilityApi
set_tenant_banner_settings POST /api/2.0/settings/banner Set the banners visibility
Security::CSPApi
configure_csp POST /api/2.0/security/csp Configure CSP settings
get_csp_settings GET /api/2.0/security/csp Get CSP settings
Security::FirebaseApi
doc_register_pusn_notification_device POST /api/2.0/settings/push/docregisterdevice Register a push device
subscribe_documents_push_notification PUT /api/2.0/settings/push/docsubscribe Set push subscription
Security::LoginHistoryApi
create_login_history_report POST /api/2.0/security/audit/login/report Start login history report
get_last_login_events GET /api/2.0/security/audit/login/last Get recent login events
get_login_events_by_filter GET /api/2.0/security/audit/login/filter Get filtered login events
get_login_history_report GET /api/2.0/security/audit/login/report Get login history report status
terminate_login_history_report DELETE /api/2.0/security/audit/login/report Terminate login history report
Security::OAuth2Api
generate_jwt_token GET /api/2.0/security/oauth2/token Generate JWT token
Security::SMTPSettingsApi
get_smtp_operation_status GET /api/2.0/smtpsettings/smtp/test/status Get SMTP test status
get_smtp_settings GET /api/2.0/smtpsettings/smtp Get SMTP settings
reset_smtp_settings DELETE /api/2.0/smtpsettings/smtp Reset SMTP settings
save_smtp_settings POST /api/2.0/smtpsettings/smtp Save SMTP settings
test_smtp_settings GET /api/2.0/smtpsettings/smtp/test Test SMTP settings
Settings
Method HTTP request Description
Settings::AccessToDevToolsApi
get_tenant_access_dev_tools_settings GET /api/2.0/settings/devtoolsaccess Get the Developer Tools access settings
Settings::AuthorizationApi
get_auth_services GET /api/2.0/settings/authservice Get the authorization services
save_auth_keys POST /api/2.0/settings/authservice Save the authorization keys
test_external_database_connection POST /api/2.0/settings/authservice/externaldb/test Test external database connection
Settings::BannersVisibilityApi
get_tenant_banner_settings GET /api/2.0/settings/banner Get the banners visibility
Settings::CommonSettingsApi
close_admin_helper PUT /api/2.0/settings/closeadminhelper Close the admin helper
complete_wizard PUT /api/2.0/settings/wizard/complete Complete the Wizard settings
configure_deep_link POST /api/2.0/settings/deeplink Configure the deep link settings
delete_portal_color_theme DELETE /api/2.0/settings/colortheme Delete a color theme
get_deep_link_settings GET /api/2.0/settings/deeplink Get the deep link settings
get_payment_settings GET /api/2.0/settings/payment Get the payment settings
get_portal_color_theme GET /api/2.0/settings/colortheme Get a color theme
get_portal_hostname GET /api/2.0/settings/machine Get the portal hostname
get_portal_logo GET /api/2.0/settings/logo Get a portal logo
get_portal_settings GET /api/2.0/settings Get the portal settings
get_socket_settings GET /api/2.0/settings/socket Get the socket settings
get_supported_cultures GET /api/2.0/settings/cultures Get supported languages
get_tenant_ai_access_settings GET /api/2.0/settings/ai-access Get the AI access settings
get_tenant_user_invitation_settings GET /api/2.0/settings/invitationsettings Get the user invitation settings
get_time_zones GET /api/2.0/settings/timezones Get time zones
save_default_folder PUT /api/2.0/settings/defaultfolder Set the default folder
save_dns_settings PUT /api/2.0/settings/dns Save the DNS settings
save_mail_domain_settings POST /api/2.0/settings/maildomainsettings Save the mail domain settings
save_portal_color_theme PUT /api/2.0/settings/colortheme Save a color theme
set_tenant_ai_access_settings POST /api/2.0/settings/ai-access Set the AI access settings
update_email_activation_settings PUT /api/2.0/settings/emailactivation Update the email activation settings
update_invitation_settings PUT /api/2.0/settings/invitationsettings Update the user invitation settings
Settings::CookiesApi
get_cookie_settings GET /api/2.0/settings/cookiesettings Get the cookie lifetime settings
update_cookie_settings PUT /api/2.0/settings/cookiesettings Update the cookie lifetime settings
Settings::DocsCloudApi
calculate_dev_pack POST /api/2.0/settings/docscloud/calculatedevpack Calculate the Docs Connect Dev Pack switch cost
create_tenant_quota_report POST /api/2.0/settings/docscloud/tenant/quota/report Start the Docs Connect quota report
get_tenant GET /api/2.0/settings/docscloud/tenant Get the Docs Connect tenant
get_tenant_config GET /api/2.0/settings/docscloud/tenant/config Get the Docs Connect tenant configuration
get_tenant_info GET /api/2.0/settings/docscloud/tenant/info Get the Docs Connect tenant information
get_tenant_quota GET /api/2.0/settings/docscloud/tenant/quota Get the Docs Connect tenant quota
get_tenant_quota_report GET /api/2.0/settings/docscloud/tenant/quota/report Get the Docs Connect quota report status
get_tenant_usage GET /api/2.0/settings/docscloud/tenant/usage Get the Docs Connect tenant usage
start_docs_cloud_trial POST /api/2.0/settings/docscloud/trial Start the Docs Connect trial
switch_to_dev_pack POST /api/2.0/settings/docscloud/switchtodevpack Switch Docs Connect to Docs Connect Dev Pack
terminate_tenant_quota_report DELETE /api/2.0/settings/docscloud/tenant/quota/report Terminate the Docs Connect quota report
update_tenant_config PUT /api/2.0/settings/docscloud/tenant/config Update the Docs Connect tenant configuration
Settings::EncryptionApi
get_storage_encryption_progress GET /api/2.0/settings/encryption/progress Get the storage encryption progress
get_storage_encryption_settings GET /api/2.0/settings/encryption/settings Get the storage encryption settings
start_storage_encryption POST /api/2.0/settings/encryption/start Start the storage encryption
Settings::GreetingSettingsApi
get_greeting_settings GET /api/2.0/settings/greetingsettings Get greeting settings
get_is_default_greeting_settings GET /api/2.0/settings/greetingsettings/isdefault Check the default greeting settings
restore_greeting_settings POST /api/2.0/settings/greetingsettings/restore Restore the greeting settings
save_greeting_settings POST /api/2.0/settings/greetingsettings Save the greeting settings
Settings::IPRestrictionsApi
get_ip_restrictions GET /api/2.0/settings/iprestrictions Get IP restrictions
read_ip_restrictions_settings GET /api/2.0/settings/iprestrictions/settings Get IP restriction settings
save_ip_restrictions PUT /api/2.0/settings/iprestrictions Save IP restrictions
update_ip_restrictions_settings PUT /api/2.0/settings/iprestrictions/settings Update IP restriction settings
Settings::LicenseApi
accept_license POST /api/2.0/settings/license/accept Activate a license
get_is_license_required GET /api/2.0/settings/license/required Check if a license is required
refresh_license GET /api/2.0/settings/license/refresh Refresh the license
upload_license POST /api/2.0/settings/license Upload a license
Settings::LoginSettingsApi
get_login_settings GET /api/2.0/settings/security/loginsettings Get login settings
set_default_login_settings DELETE /api/2.0/settings/security/loginsettings Reset login settings
update_login_settings PUT /api/2.0/settings/security/loginsettings Update login settings
Settings::MessagesApi
enable_admin_message_settings POST /api/2.0/settings/messagesettings Enable or disable administrator messages
send_admin_mail POST /api/2.0/settings/sendadmmail Send a message to the administrator
send_join_invite_mail POST /api/2.0/settings/sendjoininvite Send an invitation email
Settings::NotificationsApi
get_notification_channels GET /api/2.0/settings/notification/channels Get notification channels
get_notification_settings GET /api/2.0/settings/notification/{type} Check notification availability
get_rooms_notification_settings GET /api/2.0/settings/notification/rooms Get muted rooms
set_notification_settings POST /api/2.0/settings/notification Set notification status
set_rooms_notification_status POST /api/2.0/settings/notification/rooms Mute or unmute a room
Settings::OwnerApi
send_owner_change_instructions POST /api/2.0/settings/owner Start the portal owner change
update_portal_owner PUT /api/2.0/settings/owner Confirm the portal owner change
Settings::QuotaApi
get_user_quota_settings GET /api/2.0/settings/userquotasettings Get the user quota settings
save_ai_agent_quota_settings POST /api/2.0/settings/aiagentquotasettings Save the AI Agent quota settings
save_room_quota_settings POST /api/2.0/settings/roomquotasettings Save the room quota settings
set_tenant_quota_settings PUT /api/2.0/settings/tenantquotasettings Save the tenant quota settings
Settings::RebrandingApi
delete_additional_white_label_settings DELETE /api/2.0/settings/rebranding/additional Delete the additional white label settings
delete_company_white_label_settings DELETE /api/2.0/settings/rebranding/company Delete the company white label settings
get_additional_white_label_settings GET /api/2.0/settings/rebranding/additional Get the additional white label settings
get_company_white_label_settings GET /api/2.0/settings/rebranding/company Get the company white label settings
get_enable_whitelabel GET /api/2.0/settings/enablewhitelabel Check the white label availability
get_is_default_white_label_logo_text GET /api/2.0/settings/whitelabel/logotext/isdefault Check the default logo text
get_is_default_white_label_logos GET /api/2.0/settings/whitelabel/logos/isdefault Check the default white label logos
get_licensor_data GET /api/2.0/settings/companywhitelabel Get the licensor data
get_white_label_logo_text GET /api/2.0/settings/whitelabel/logotext Get the white label logo text
get_white_label_logos GET /api/2.0/settings/whitelabel/logos Get the white label logos
restore_white_label_logo_text PUT /api/2.0/settings/whitelabel/logotext/restore Restore the white label logo text
restore_white_label_logos PUT /api/2.0/settings/whitelabel/logos/restore Restore the white label logos
save_additional_white_label_settings POST /api/2.0/settings/rebranding/additional Save the additional white label settings
save_company_white_label_settings POST /api/2.0/settings/rebranding/company Save the company white label settings
save_white_label_logo_text POST /api/2.0/settings/whitelabel/logotext/save Save the white label logo text
save_white_label_settings POST /api/2.0/settings/whitelabel/logos/save Save the white label logos
save_white_label_settings_from_files POST /api/2.0/settings/whitelabel/logos/savefromfiles Save the logos from files
Settings::SSOApi
get_default_sso_settings_v2 GET /api/2.0/settings/ssov2/default Get the default SSO settings
get_sso_settings_v2 GET /api/2.0/settings/ssov2 Get the SSO settings
get_sso_settings_v2_constants GET /api/2.0/settings/ssov2/constants Get the SSO settings constants
reset_sso_settings_v2 DELETE /api/2.0/settings/ssov2 Reset the SSO settings
save_sso_settings_v2 POST /api/2.0/settings/ssov2 Save the SSO settings
Settings::SecurityApi
get_enabled_modules GET /api/2.0/settings/security/modules Get enabled modules
get_is_product_administrator GET /api/2.0/settings/security/administrator Check product administrator
get_password_settings GET /api/2.0/settings/security/password Get password settings
get_product_administrators GET /api/2.0/settings/security/administrator/{productId} Get product administrators
get_web_item_security_info GET /api/2.0/settings/security/{id} Check module availability
get_web_item_settings_security_info GET /api/2.0/settings/security Get module access settings
set_access_to_web_items PUT /api/2.0/settings/security/access Set access to modules in bulk
set_product_administrator PUT /api/2.0/settings/security/administrator Set product administrator
set_web_item_security PUT /api/2.0/settings/security Set module access
update_password_settings PUT /api/2.0/settings/security/password Update password settings
Settings::StatisticsApi
get_space_usage_statistics GET /api/2.0/settings/statistics/spaceusage/{id} Get the space usage statistics
Settings::StorageApi
get_all_backup_storages GET /api/2.0/settings/storage/backup Get the backup storages
get_all_cdn_storages GET /api/2.0/settings/storage/cdn Get the CDN storages
get_all_storages GET /api/2.0/settings/storage Get the portal storages
get_amazon_s3_regions GET /api/2.0/settings/storage/s3/regions Get the Amazon S3 regions
get_storage_progress GET /api/2.0/settings/storage/progress Get the storage migration progress
reset_cdn_to_default DELETE /api/2.0/settings/storage/cdn Reset the CDN storage settings
reset_storage_to_default DELETE /api/2.0/settings/storage Reset the storage settings
update_cdn_storage PUT /api/2.0/settings/storage/cdn Update the CDN storage
update_storage PUT /api/2.0/settings/storage Switch the portal storage
Settings::TFASettingsApi
get_tfa_app_codes GET /api/2.0/settings/tfaappcodes Get the TFA backup codes
get_tfa_confirm_data GET /api/2.0/settings/tfaapp/confirm Get TFA confirmation data
get_tfa_settings GET /api/2.0/settings/tfaapp Get the TFA settings
tfa_app_generate_setup_code GET /api/2.0/settings/tfaapp/setup Generate the TFA setup code
tfa_validate_auth_code POST /api/2.0/settings/tfaapp/validate Validate the TFA code
unlink_tfa_app PUT /api/2.0/settings/tfaappnewapp Unlink the TFA application
update_tfa_app_codes PUT /api/2.0/settings/tfaappnewcodes Regenerate the TFA backup codes
update_tfa_settings PUT /api/2.0/settings/tfaapp Update the TFA settings
update_tfa_settings_link PUT /api/2.0/settings/tfaappwithlink Update TFA settings with a link
Settings::TelegramApi
check_telegram GET /api/2.0/settings/telegram/check Check the Telegram connection
link_telegram GET /api/2.0/settings/telegram/link Get the Telegram link
unlink_telegram DELETE /api/2.0/settings/telegram/link Unlink Telegram
Settings::WebhooksApi
create_webhook POST /api/2.0/settings/webhook Create a webhook
enable_webhook PUT /api/2.0/settings/webhook/enable Switch a webhook on or off
get_tenant_webhooks GET /api/2.0/settings/webhook Get the portal webhooks
get_webhook_triggers GET /api/2.0/settings/webhook/triggers Get the webhook triggers
get_webhooks_logs GET /api/2.0/settings/webhooks/log Get the webhook delivery log
remove_webhook DELETE /api/2.0/settings/webhook/{id} Remove a webhook
retry_webhook PUT /api/2.0/settings/webhook/{id}/retry Retry a webhook delivery
retry_webhooks PUT /api/2.0/settings/webhook/retry Retry webhook deliveries
update_webhook PUT /api/2.0/settings/webhook Update a webhook
Settings::WebpluginsApi
add_web_plugin_from_file POST /api/2.0/settings/webplugins Add a web plugin
delete_web_plugin DELETE /api/2.0/settings/webplugins/{name} Delete a web plugin
get_web_plugin GET /api/2.0/settings/webplugins/{name} Get a web plugin by name
get_web_plugins GET /api/2.0/settings/webplugins Get web plugins
refresh_web_plugin PUT /api/2.0/settings/webplugins/{name}/refresh Refresh a web plugin
update_web_plugin PUT /api/2.0/settings/webplugins/{name} Update a web plugin
ThirdParty
Method HTTP request Description
ThirdParty::ThirdPartyApi
get_third_party_code GET /api/2.0/thirdparty/{provider} Get provider consent URL

Documentation For Models

Models list

About

A simple Ruby SDK for integrating with the ONLYOFFICE DocSpace API

Topics

docspaceintegrationonlyofficesdk

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Contributors

Languages