Move a file between folders

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

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

Request

Example request

POST /v2/files/{file_id}/actions/move HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
Content-Type: application/json

curl --data '@move.json' -X POST -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "Content-Type: application/json" 'https://cgc-api.sbgenomics.com/files'

Header Fields

Name	Description
`X-SBG-Auth-Token` required	Your CGC 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 request body

{
  "parent": "57ee602e1c94d72f08ba34e8", 
  "name": "1000G_omni2.5.hg38.vcf"
}

Response

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