Move a file between folders

/files

This call moves a file from one folder to another. Moving of files is only allowed within the same project.

https://cavatica-api.sbgenomics.com/v2/files/{file_id}/actions/move

Request

Example request

POST /v2/files/{file_id}/actions/move HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
curl --data '@move.json' -X POST -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-Type: application/json" 'https://cavatica-api.sbgenomics.com/files'

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Content-Type
required

application/json

Request body

In the request body, you should enter the following list of key-value pairs:

Name

Data type

Description

parent
required

String

Specifies the target folder by using its ID.
To find out the folder ID, use the List folder contents call for its parent folder.

name

String

Specifies a new name for a file in case you want to rename it.
If you want to use the same name, omit this key.

Example response body

{
  "parent": "567890abc9b0307bc0414164", 
  "name": "1000G_omni2.5.hg38.vcf"
}

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response..

Language
Click Try It! to start a request and see the response here!