### API Usage: Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/tfa-validate-auth-code

This section provides links to essential 'Get Started' guides for the ONLYOFFICE DocSpace API Backend, covering basic concepts, obtaining the software, authentication, and how long-running operations work.

```APIDOC
GET /zh-CN/docspace/api-backend/get-started/basic-concepts/
  Description: Provides an overview of basic concepts for the DocSpace API Backend.

GET /zh-CN/docspace/api-backend/get-started/get-onlyoffice-docspace/
  Description: Guide on how to obtain and set up ONLYOFFICE DocSpace.

GET /zh-CN/docspace/api-backend/get-started/authentication/
  Description: Details on authentication methods for the DocSpace API.

GET /zh-CN/docspace/api-backend/get-started/how-it-works/long-running-operations/
  Description: Explains how long-running operations are handled by the API.

GET /zh-CN/docspace/api-backend/get-started/server-sdks/
  Description: Information on server SDKs available for integration.

GET /zh-CN/docspace/api-backend/get-started/mcp-server/
  Description: Details about the MCP Server component.
```

--------------------------------

### ONLYOFFICE DocSpace Backend API - Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/create-primary-external-link

This section provides introductory information and endpoints for getting started with the ONLYOFFICE DocSpace Backend REST API, covering basic concepts and setup.

```APIDOC
API Endpoint: Get Started

Description: Contains endpoints and information for initial setup and understanding of the ONLYOFFICE DocSpace Backend REST API.

Methods:
- Basic concepts: Endpoint providing fundamental concepts of the API.
- Get ONLYOFFICE DocSpace: Endpoint related to obtaining or setting up DocSpace.
- Authentication: Endpoint for authentication procedures.
- How it works: Endpoint explaining the operational flow, including long-running operations.
- SDKs: Endpoint related to Server SDKs.
- MCP Server: Endpoint related to the MCP Server.
```

--------------------------------

### ONLYOFFICE DocSpace API - Basic Concepts and Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/perform-customer-operation

This section covers the fundamental concepts and initial steps required to get started with the ONLYOFFICE DocSpace Backend REST API, including basic setup and understanding of the platform.

```APIDOC
APIDOC:
  Group: Get Started

  Basic concepts:
    GET /concepts
    Description: Provides an overview of the core concepts of ONLYOFFICE DocSpace API.
    Returns: Documentation on basic concepts.

  Get ONLYOFFICE DocSpace:
    GET /docspace/get
    Description: Information on how to obtain or set up ONLYOFFICE DocSpace.
    Returns: Setup and acquisition guide.

  Authentication:
    GET /authentication/info
    Description: Details on authentication methods and requirements for API access.
    Returns: Authentication protocols and examples.

  How it works (Long Running Operations):
    GET /operations/long-running
    Description: Explains the process and handling of long-running operations within the API.
    Returns: Guide to managing asynchronous tasks.

  SDKs:
    GET /sdks/list
    Description: Lists available Server SDKs for integrating with the API.
    Returns: List of supported SDKs and their documentation links.

  MCP Server:
    GET /mcp-server/info
    Description: Information regarding the MCP Server and its role in DocSpace.
    Returns: MCP Server overview.
```

--------------------------------

### ONLYOFFICE DocSpace Backend API - Get Started Concepts

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-folders

Documentation for basic concepts and getting started with the ONLYOFFICE DocSpace Backend API.

```APIDOC
Get Started:
  - Basic concepts: /zh-CN/docspace/api-backend/get-started/basic-concepts/
  - Get ONLYOFFICE DocSpace: /zh-CN/docspace/api-backend/get-started/get-onlyoffice-docspace/
  - Authentication: /zh-CN/docspace/api-backend/get-started/authentication/
  - How it works (long running operations): /zh-CN/docspace/api-backend/get-started/how-it-works/long-running-operations/
  - SDKs (server SDKs): /zh-CN/docspace/api-backend/get-started/server-sdks/
  - MCP Server: /zh-CN/docspace/api-backend/get-started/mcp-server/
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Basic Concepts & Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-supported-cultures

Provides an overview of the fundamental concepts and initial steps for using the ONLYOFFICE DocSpace Backend REST API. Covers essential information for getting started with the API.

```APIDOC
API Endpoint Group: Get Started

- Basic concepts: Provides an overview of the API's architecture and core functionalities.
- Get ONLYOFFICE DocSpace: Instructions on how to obtain and set up ONLYOFFICE DocSpace.
- Authentication: Details on how to authenticate API requests, including methods like API keys and OAuth 2.0.
- How it works: Explains the operational flow, including long-running operations.
- SDKs: Information on available Software Development Kits for various platforms.
- MCP Server: Details related to the MCP Server integration.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend: Basic Concepts & Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-custom-navigation-item

Provides essential information on getting started with the ONLYOFFICE DocSpace Backend API. Covers basic concepts, how to obtain DocSpace, authentication mechanisms, and the overall architecture including MCP Server.

```APIDOC
APIDOC:
  Get started:
    - Basic concepts: Overview of the API and its functionalities.
    - Get ONLYOFFICE DocSpace: Instructions on acquiring and setting up DocSpace.
    - Authentication: Details on how to authenticate API requests.
    - How it works: Explanation of long-running operations and workflow.
    - SDKs: Information on available Server SDKs.
    - MCP Server: Details regarding the MCP Server component.
```

--------------------------------

### ONLYOFFICE DocSpace API - Get Started & Basic Concepts

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/samples/rooms-management

Provides an overview of essential concepts for interacting with the ONLYOFFICE DocSpace Backend REST API. Covers basic setup, authentication, and how the API functions, including long-running operations.

```APIDOC
API Endpoint Group: Get Started

1.  **Basic Concepts**
    *   URL: `/zh-CN/docspace/api-backend/get-started/basic-concepts/`
    *   Description: Introduces fundamental principles and architecture of the ONLYOFFICE DocSpace Backend API.

2.  **Get ONLYOFFICE DocSpace**
    *   URL: `/zh-CN/docspace/api-backend/get-started/get-onlyoffice-docspace/`
    *   Description: Guides on how to obtain and set up an instance of ONLYOFFICE DocSpace for API integration.

3.  **Authentication**
    *   URL: `/zh-CN/docspace/api-backend/get-started/authentication/`
    *   Description: Details the authentication mechanisms, likely involving API keys or tokens, required to access API endpoints.

4.  **How it works (Long-Running Operations)**
    *   URL: `/zh-CN/docspace/api-backend/get-started/how-it-works/long-running-operations/`
    *   Description: Explains the handling of asynchronous or long-running tasks within the API, providing insights into managing operations that take time to complete.

5.  **SDKs**
    *   URL: `/zh-CN/docspace/api-backend/get-started/server-sdks/`
    *   Description: Information on available Server SDKs to facilitate integration with the DocSpace API in various programming languages.

6.  **MCP Server**
    *   URL: `/zh-CN/docspace/api-backend/get-started/mcp-server/`
    *   Description: Details related to the MCP (Multi-Client Platform) Server, potentially for multi-tenancy or specific deployment scenarios.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend: Basic Concepts and Authentication

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/store-original

Covers the fundamental concepts of the ONLYOFFICE DocSpace API, including how to get started and authenticate your requests. This section outlines the initial setup and security measures required to interact with the API.

```APIDOC
Get started:
  - Basic concepts
  - Get ONLYOFFICE DocSpace
  - Authentication
  - How it works (long-running operations)
  - SDKs
  - MCP Server

Authentication:
  - Get is authenticated
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Basic Concepts and Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-portal-hostname

Provides an overview of the ONLYOFFICE DocSpace Backend API, including basic concepts, how to get started with DocSpace, authentication mechanisms, and the overall architecture.

```APIDOC
Basic Concepts:
  - Overview of ONLYOFFICE DocSpace Backend API functionality.
  - Key architectural components and workflows.

Get Started:
  - Guide to obtaining and setting up ONLYOFFICE DocSpace.
  - Initial configuration steps.

Authentication:
  - Details on authentication methods supported by the API.
  - Obtaining and managing API keys or tokens.
  - Understanding authentication flows.

How it works:
  - Explanation of long-running operations and their management.
  - Asynchronous task processing.

SDKs:
  - Information on available server SDKs for integration.

MCP Server:
  - Details regarding the MCP Server and its role in the DocSpace ecosystem.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend: Basic Concepts and Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/update-tfa-app-codes

Provides foundational information for integrating with the ONLYOFFICE DocSpace Backend API. Covers essential concepts, setup, and how the system operates, including long-running operations and SDKs.

```APIDOC
API Endpoint Group: Get Started

- Basic concepts: Provides an overview of the API's core functionalities and architecture.
- Get ONLYOFFICE DocSpace: Instructions on how to obtain and set up ONLYOFFICE DocSpace.
- Authentication: Details on the authentication mechanisms used by the API.
- How it works: Explains the operational flow, including long-running operations.
- SDKs: Information on available Software Development Kits for various languages.
- MCP Server: Specifics related to the MCP Server component.
```

--------------------------------

### API: Basic Concepts & Get Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-web-plugin

Provides foundational information for using the ONLYOFFICE DocSpace Backend API. Covers essential concepts, how to obtain DocSpace, authentication methods, and the overall architecture including long-running operations and SDKs.

```APIDOC
API: Basic Concepts
  - Overview of ONLYOFFICE DocSpace Backend API.
  - Getting started guide.

API: Get ONLYOFFICE DocSpace
  - Instructions on how to acquire and set up ONLYOFFICE DocSpace.

API: Authentication
  - Details on authentication methods for API access.
  - Covers obtaining API keys and verifying identity.

API: How it works
  - Explanation of the API's operational flow.
  - Focus on long-running operations and their management.

API: SDKs
  - Information on available Server SDKs for integration.

API: MCP Server
  - Details related to the MCP Server functionality within DocSpace.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Basic Concepts & Authentication

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/terminate-reassign

Covers the fundamental concepts of the ONLYOFFICE DocSpace API Backend, including how to get started, authentication methods, and the overall architecture. Essential for understanding API interactions.

```APIDOC
API Documentation - Basic Concepts:
  - Get started with ONLYOFFICE DocSpace
  - Authentication methods and best practices
  - How the API works, including long-running operations
  - SDKs and MCP Server information
```

--------------------------------

### Start Storage Encryption Process

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/start-storage-encryption

Initiates the storage encryption process for the ONLYOFFICE DocSpace. This API endpoint handles the request to start encryption and returns a status indicating success or failure.

```APIDOC
POST /api/2.0/settings/encryption/start

Starts the storage encryption process.

## Request

No specific request body details are provided in the documentation, but the method is POST.

## Responses

*   **200 OK**: Boolean value: true if the operation is successful.
*   **401 Unauthorized**: Your pricing plan does not support this option.
*   **402 Forbidden**: No permissions to perform this action.
*   **403 Forbidden**: Method not allowed.
*   **405 Method Not Allowed**: Method not allowed.
```

--------------------------------

### Basic Concepts and Authentication API Endpoints

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-accounting-currencies

Documentation for fundamental concepts and authentication mechanisms for the ONLYOFFICE DocSpace Backend REST API. This section covers how to get started and authenticate requests.

```APIDOC
Getting Started and Authentication:
  - Basic Concepts: Overview of the API structure and functionality.
  - Get ONLYOFFICE DocSpace: Information on obtaining and setting up DocSpace.
  - Authentication: Details on how to authenticate API requests (e.g., API keys, OAuth 2.0).
  - How it works: Explanation of long-running operations.
  - SDKs: Information on available Server SDKs.
  - MCP Server: Details related to the MCP Server.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Basic Concepts & Getting Started

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-storage-encryption-settings

Provides foundational information for interacting with the ONLYOFFICE DocSpace API Backend. Covers essential concepts, how to obtain DocSpace, authentication methods, and the workflow of long-running operations.

```APIDOC
API Group: Get Started

Basic Concepts:
  Description: Explains the fundamental principles and architecture of the ONLYOFFICE DocSpace API.
  Content: Overview of API structure, data formats, and general usage patterns.

Get ONLYOFFICE DocSpace:
  Description: Guide on how to acquire and set up an instance of ONLYOFFICE DocSpace for API integration.

Authentication:
  Description: Details the authentication mechanisms required to access the DocSpace API, including token-based authentication and OAuth 2.0 flows.
  Methods:
    - POST /api/v1/oauth2/authorize: Initiates the OAuth 2.0 authorization code grant flow.
    - POST /api/v1/oauth2/token: Exchanges an authorization code for an access token.
    - GET /api/v1/is-authenticated: Checks the current authentication status.

How it works (Long-running operations):
  Description: Explains the handling of asynchronous or long-running tasks within the API, including status tracking.

SDKs:
  Description: Information on available Server SDKs for various programming languages to simplify API integration.

MCP Server:
  Description: Details related to the MCP Server, potentially for specific deployment or management scenarios.
```

--------------------------------

### ONLYOFFICE DocSpace API: Basic Concepts & Authentication

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/hide-confirm-cancel-operation

Provides foundational information on how to get started with the ONLYOFFICE DocSpace API, including essential concepts and authentication mechanisms. This section covers the initial setup and requirements for API interaction.

```APIDOC
API Reference: Basic Concepts
  - Get started with ONLYOFFICE DocSpace API.
  - Details on how the API works.
  - Information on obtaining ONLYOFFICE DocSpace.

API Reference: Authentication
  - Methods for authenticating API requests.
  - Obtaining and managing API keys.
  - Verifying authentication status.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Samples

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/terminate-reassign

Provides links to sample code demonstrating common API usage patterns, such as user authentication and file/folder management.

```APIDOC
API Documentation - Samples:
  - Authentication: Sample code for authenticating a user.
  - Files Management: Sample code for managing files.
  - Folders Management: Sample code for managing folders.
```

--------------------------------

### ONLYOFFICE DocSpace API - Samples Overview

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/samples/rooms-management

Lists available sample use cases for the ONLYOFFICE DocSpace Backend API, covering authentication, file and folder management, user contacts, room management, and general API samples.

```APIDOC
API Endpoint Group: Samples

1.  **Authenticate a user**
    *   URL: `/zh-CN/docspace/api-backend/samples/authentication/`
    *   Description: Example demonstrating user authentication flows.

2.  **Manage files**
    *   URL: `/zh-CN/docspace/api-backend/samples/files-management/`
    *   Description: Sample code for performing file operations like upload, download, and manipulation.

3.  **Manage folders**
    *   URL: `/zh-CN/docspace/api-backend/samples/folders-management/`
    *   Description: Examples for creating, organizing, and managing folders.

4.  **Manage user contacts**
    *   URL: `/zh-CN/docspace/api-backend/samples/manage-user-contacts/`
    *   Description: Demonstrates how to manage user contacts within the system.

5.  **Manage rooms**
    *   URL: `/zh-CN/docspace/api-backend/samples/rooms-management/`
    *   Description: Sample code for room management operations (create, get, rename, archive, delete).

6.  **DocSpace REST API samples**
    *   URL: `/zh-CN/docspace/api-backend/samples/`
    *   Description: General collection of samples for the DocSpace REST API.

7.  **Manage users**
    *   URL: `/zh-CN/docspace/api-backend/samples/users-management/`
    *   Description: Examples for user management tasks, such as creating, updating, or deleting users.
```

--------------------------------

### Start Migration API Endpoint

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/start-migration

Initiates the migration process for ONLYOFFICE DocSpace. This API endpoint is used to start a data migration task.

```APIDOC
Start migration:
  POST /api/2.0/migration/migrate

  Starts the migration process.

  Request:
    (No specific request body details provided in the snippet)

  Response:
    (No specific response details provided in the snippet)

  Related Methods:
    - Upload and initialize migration: POST /api/2.0/migration/upload
    - Get migration status: GET /api/2.0/migration/status/{migrationId}
    - Cancel migration: POST /api/2.0/migration/cancel/{migrationId}
    - Clear migration: POST /api/2.0/migration/clear/{migrationId}
    - Finish migration: POST /api/2.0/migration/finish/{migrationId}
    - Get migration logs: GET /api/2.0/migration/logs/{migrationId}
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Basic Concepts and Usage

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/check-doc-service-url

Provides an overview of the ONLYOFFICE DocSpace Backend REST API, including essential concepts, getting started guides, authentication mechanisms, and general API usage patterns. It covers topics like API keys, authentication checks, and long-running operations.

```APIDOC
API Usage Overview:

- Get started with Basic Concepts: Covers fundamental principles of the DocSpace API.
- Get ONLYOFFICE DocSpace: Information on obtaining and setting up DocSpace.
- Authentication: Details on how to authenticate API requests.
- How it works: Explains long-running operations and their management.
- SDKs: Information on available Server SDKs for integration.
- MCP Server: Specifics related to the MCP Server.

API Keys Management:

- Create API Key: Endpoint for generating new API keys.
- Get is Authenticated: Endpoint to check the authentication status.

Backup Operations:

- Get Backup Schedule: Retrieves the current backup schedule settings.

Portal Capabilities:

- Get Portal Capabilities: Fetches information about the portal's available features.

File Operations:

- Save Editing File from Form: Endpoint for saving files edited via forms.
- Get Folder History: Retrieves the history of a specific folder.
- Check Conversion Status: Monitors the status of file conversion operations.
- Update Rooms Quota: Modifies the storage quota for rooms.
- Check Doc Service URL: Verifies the availability and correctness of the document service URL.
- Get Doc Service URL: Retrieves the configured document service URL.
```

--------------------------------

### Get Folder Details Python Example

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/samples/folders-management

Python function to retrieve folder details using the ONLYOFFICE DocSpace API. It constructs the URL and sends a GET request.

```Python
def get_folder_details(folder_id):
    url = f'{BASE_URL}/api/2.0/files/folder/{folder_id}'
    requests.get(url, headers=headers)
```

--------------------------------

### API: Keys Management

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/tfa-app-generate-setup-code

Handles the creation and management of API keys for accessing the ONLYOFFICE DocSpace API.

```APIDOC
Keys Management:

  createApiKey(name: string)
    - Creates a new API key for the user or tenant.
    - Parameters:
      - name: A descriptive name for the API key.
    - Returns: Object containing the newly generated API key and its details.
```

--------------------------------

### Node.js and Python OAuth 2.0 Integration Samples

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/get-started/authentication/oauth2

Example code snippets and integration guides for Node.js and Python demonstrating how to implement OAuth 2.0 with ONLYOFFICE DocSpace. These samples help developers connect their applications to DocSpace for authorization and API access.

```Node.js
Refer to the GitHub repository for Node.js examples:
https://github.com/ONLYOFFICE/docspace-samples/tree/develop/oauth2
```

```Python
Refer to the GitHub repository for Python examples:
https://github.com/ONLYOFFICE/docspace-samples/tree/develop/oauth2
```

--------------------------------

### API: Get Storages

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/update-storage

Retrieves a list of all available storage configurations within the DocSpace. This endpoint provides information about the current storage setup.

```APIDOC
GET /api/v2/storages

Description:
  Retrieves a list of all available storage configurations.

Parameters:
  None

Returns:
  An array of storage objects, each containing details like storage type, configuration, and status.

Example:
  [{"id": "storage-1", "type": "local", "path": "/var/www/onlyoffice/Data", "isDefault": true}]
```

--------------------------------

### Manage rooms

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/samples

Demonstrates how to manage rooms within ONLYOFFICE DocSpace using the API. This includes creating room templates and managing room settings.

```APIDOC
API Endpoint: POST /api/v2/rooms/templates

Description:
Creates a new room template.

Request Body:
{
  "name": "string",
  "description": "string" (optional)
}

Parameters:
- name (string): The name of the room template.
- description (string, optional): A description for the template.

Returns:
{
  "templateId": "string",
  "name": "string"
}

API Endpoint: GET /api/v2/rooms/{roomId}

Description:
Retrieves details for a specific room.

Parameters:
- roomId (string): The ID of the room.

Returns:
Room details object.
```

--------------------------------

### Get Backup History API

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-backup-history

Retrieves the history of started backups for ONLYOFFICE DocSpace. This API endpoint allows users to query the status and records of backup operations.

```APIDOC
GET
/api/2.0/backup/getbackuphistory

Description:
Returns the history of the started backup.

Request:
No specific request body or parameters are detailed in this snippet, but it implies a GET request to the specified endpoint.

Response:
Returns the history of the started backup. Specific response schema is not provided in this snippet.
```

--------------------------------

### Get CDN Storages API Endpoint

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-all-cdn-storages

Retrieves a list of all configured CDN storages. This endpoint provides details about the CDN storage setup within the DocSpace environment.

```APIDOC
GET /api/2.0/settings/storage/cdn

Description:
  Returns a list of all the CDN storages.

Responses:
  200 OK:
    Description: List of the CDN storages with the following parameters
  401 Unauthorized:
    Description: Unauthorized
  403 Forbidden:
    Description: No permissions to perform this action

Related Operations:
  - Get the storage progress
  - Update the CDN storage
```

--------------------------------

### API: Migration Management

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/tfa-app-generate-setup-code

Allows listing and managing migration processes within the ONLYOFFICE DocSpace.

```APIDOC
Migration Management:

  listMigrations()
    - Lists all ongoing or completed migration processes.
    - Returns: Array of migration process objects.
```

--------------------------------

### ONLYOFFICE DocSpace API Backend - Room Management

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/get-supported-cultures

Covers API endpoints for managing rooms and room templates within ONLYOFFICE DocSpace. This includes creating and managing room templates for consistent room setups.

```APIDOC
API Endpoint Group: Rooms

- Create room template: Allows for the creation of templates that define the structure and settings for new rooms.
```

--------------------------------

### Backup Operations API

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/delete-backup-schedule

Manages backup schedules and processes for ONLYOFFICE DocSpace. Includes endpoints for getting, creating, deleting backup schedules, starting backups, and monitoring progress.

```APIDOC
Backup Operations:

- Get the backup schedule:
  GET /api/2.0/backup/getbackupschedule
  Description: Retrieves the current backup schedule configuration.
  Returns: Backup schedule details.

- Create the backup schedule:
  POST /api/2.0/backup/createbackupschedule
  Description: Creates or updates the backup schedule for the portal.
  Parameters:
    - schedule: Object containing backup schedule settings (e.g., frequency, time).
  Returns: Confirmation of schedule creation.

- Delete the backup schedule:
  DELETE /api/2.0/backup/deletebackupschedule
  Description: Deletes the backup schedule of the current portal.
  Returns: Confirmation of schedule deletion.

- Start the backup:
  POST /api/2.0/backup/startbackup
  Description: Initiates a manual backup process.
  Returns: Status of the backup initiation.

- Get the backup progress:
  GET /api/2.0/backup/getbackupprogress
  Description: Retrieves the current status and progress of ongoing backup operations.
  Returns: Backup progress information.

- Get the backup history:
  GET /api/2.0/backup/getbackuphistory
  Description: Lists all completed backup operations and their details.
  Returns: List of backup history records.

- Delete the backup:
  DELETE /api/2.0/backup/deletebackup
  Description: Deletes a specific backup file.
  Parameters:
    - backupId: The ID of the backup to delete.
  Returns: Confirmation of backup deletion.

- Delete the backup history:
  DELETE /api/2.0/backup/deletebackuphistory
  Description: Clears the backup history records.
  Returns: Confirmation of history deletion.

- Start the restoring process:
  POST /api/2.0/backup/startbackuprestore
  Description: Initiates the restoration process from a backup.
  Parameters:
    - backupId: The ID of the backup to restore from.
  Returns: Status of the restoration initiation.

- Get the restoring progress:
  GET /api/2.0/backup/getrestoreprogress
  Description: Retrieves the current status and progress of ongoing restoration operations.
  Returns: Restoration progress information.
```

--------------------------------

### ONLYOFFICE DocSpace API Usage Examples

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/usage-api/change-automatically-clean-up

This section provides examples of common API operations for ONLYOFFICE DocSpace, including managing API keys, checking authentication status, retrieving backup schedules, and managing files and folders.

```APIDOC
APIDOC:
  Group: API Key and Authentication
  Endpoints:
    - POST /api/v1/api-keys: Create API key
      Description: Generates a new API key for accessing the DocSpace API.
      Parameters:
        - body (object): Request body containing details for key generation.
      Returns: JSON object with the new API key and its details.
    - GET /api/v1/is-authenticated: Get authentication status
      Description: Checks if the current session or token is authenticated.
      Returns: JSON object indicating authentication status.

  Group: System Information and Management
  Endpoints:
    - GET /api/v1/backup/schedule: Get backup schedule
      Description: Retrieves the configured backup schedule for the DocSpace instance.
      Returns: JSON object with backup schedule details.
    - GET /api/v1/portal/capabilities: Get portal capabilities
      Description: Fetches information about the features and capabilities supported by the portal.
      Returns: JSON object listing portal capabilities.

  Group: File and Folder Operations
  Endpoints:
    - PUT /api/v1/files/save-editing-file-from-form: Save editing file from form
      Description: Saves a file that is being edited, potentially from a form submission.
      Parameters:
        - body (object): File data and associated form information.
      Returns: Success or failure status.
    - GET /api/v1/folders/history: Get folder history
      Description: Retrieves the version history or activity log for a specific folder.
      Returns: JSON object with folder history data.
    - POST /api/v1/operations/check-conversion-status: Check conversion status
      Description: Queries the status of a document conversion operation.
      Parameters:
        - body (object): Request body containing operation ID or details.
      Returns: JSON object with the conversion status.
    - PUT /api/v1/rooms/quota: Update rooms quota
      Description: Modifies the storage quota for specific rooms.
      Parameters:
        - body (object): Room ID and new quota information.
      Returns: Success or failure status.
```

--------------------------------

### Manage folders

Source: https://api.onlyoffice.com/zh-CN/docspace/api-backend/samples

Demonstrates how to manage folders within ONLYOFFICE DocSpace using the API. This includes creating, listing, and deleting folders.

```APIDOC
API Endpoint: POST /api/v2/folders

Description:
Creates a new folder.

Request Body:
{
  "name": "string",
  "parentId": "string" (optional)
}

Parameters:
- name (string): The name of the new folder.
- parentId (string, optional): The ID of the parent folder. If omitted, creates in the root.

Returns:
{
  "folderId": "string",
  "name": "string",
  "parentId": "string"
}

API Endpoint: GET /api/v2/folders/{folderId}

Description:
Retrieves information about a specific folder.

Parameters:
- folderId (string): The ID of the folder.

Returns:
Folder details.

API Endpoint: DELETE /api/v2/folders/{folderId}

Description:
Deletes a folder and its contents.

Parameters:
- folderId (string): The ID of the folder to delete.

Returns:
204 No Content on success.
```