Create/Rename/Move/Copy/Revert/Convert a file

Performs an operation on the file given in p.

  • create: creates an empty file (create right on the parent folder required). Existing names are renamed automatically. .docx, .xlsx, .pptx and .docxf files are created from an Office template. For .sdoc files the response additionally contains doc_uuid, for .exdraw files file_uuid.
  • rename: requires newname (must differ from the old name, max. length limited by the server). Returns the file info of the renamed file.
  • move: requires dst_repo and dst_dir; read-write permission on source and destination folder. Existing names in the destination are renamed automatically.
  • copy: requires dst_repo and dst_dir; copy right on the source folder, read-write on the destination folder.
  • revert: requires commit_id; restores the file version of that commit.
  • convert (new in SecureCloud 13.0): requires dst_type. Converts .md -> sdoc, .docx -> sdoc or .sdoc -> markdown/docx; a new file is created next to the original. Requires the document file converter on the server.

Rename/move/revert/convert fail with 403 File is locked if the file is locked by another user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The unique identifier of a library

Query Params
string
required

The path of the file in the library

Body Params
string
enum
required
Allowed:
string

New file name (operation rename)

string

Destination library ID (operations move, copy)

string

Destination folder (operations move, copy)

string

Commit to restore (operation revert)

string
enum

Target format (operation convert): sdoc for .md/.docx files, markdown or docx for .sdoc files

Allowed:
Responses

Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json