Create the editing session

POST /api/2.0/files/file/{fileid}/edit_session

Request

Creates a session to edit the existing file with multiple chunks (needed for WebDAV).

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

fileIdintegerformat: int32required

File ID

Query

fileSizeintegerformat: int64

File size in bytes

Examples

POST /api/2.0/files/file/%7Bfileid%7D/edit_session?fileSize=1234 HTTP/1.1
Accept: application/json
Host: example.com
curl --request POST \
  --url 'https://example.com/api/2.0/files/file/%7Bfileid%7D/edit_session?fileSize=1234' \
  --header 'Accept: application/json'

Responses

200

Information about created session

401

Unauthorized

403

You don't have enough permission to edit the file

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).