Starts room index export

POST /api/2.0/files/rooms/{id}/indexexport

Request

Starts room index export

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

idintegerformat: int32required

Examples

POST /api/2.0/files/rooms/8296/indexexport HTTP/1.1
Accept: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/files/rooms/8296/indexexport \
  --header 'Accept: application/json'

Responses

200

Ok

idstring
errorstring
percentageintegerformat: int32
isCompletedboolean
statusone of
.enum of string

[Created - Created, Running - Running, Completed - Completed, Canceled - Canceled, Failted - Failted]

Can be one of: Created, Running, Completed, Canceled, Failted.

.enum of integer

[0 - Created, 1 - Running, 2 - Completed, 3 - Canceled, 4 - Failted]

Can be one of: 0, 1, 2, 3, 4.

resultFileIdunknown
resultFileNamestring
resultFileUrlstring

401

Unauthorized

403

Forbidden

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).