{"_id":"54680b5d016b480800bc7cc2","user":"5467f76e016b480800bc7c7d","editedParams":true,"editedParams2":true,"category":{"_id":"5467f78698b68408002689f8","__v":13,"project":"5467f78598b68408002689f4","pages":["5467f78698b68408002689fa","54680584016b480800bc7ca0","546806af016b480800bc7ca3","5468084998b6840800268a28","546808fe016b480800bc7ca6","546809b098b6840800268a32","54680ab898b6840800268a42","54680b5d016b480800bc7cc2","54680b9a016b480800bc7cc5","5468293298b6840800268a79","54682958016b480800bc7cf9","54682fbc016b480800bc7cfd","54f664fd542ade0d00f1c69b"],"version":"5467f78598b68408002689f7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-16T01:01:58.022Z","from_sync":false,"order":0,"slug":"api-documentation","title":"API Documentation"},"is_link":false,"project":"5467f78598b68408002689f4","version":{"_id":"5467f78598b68408002689f7","project":"5467f78598b68408002689f4","__v":1,"createdAt":"2014-11-16T01:01:57.550Z","releaseDate":"2014-11-16T01:01:57.550Z","categories":["5467f78698b68408002689f8"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-11-16T02:26:37.561Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"name":"","code":"{\n    \"data\": {\n        \"name\": \"baz\",\n        \"path\": \"/baz\",\n        \"type\": \"directory\",\n        \"size\": 136,\n        \"atime\": 1416092956000,\n        \"mtime\": 1416092956000,\n        \"link\": false\n    }\n}","language":"json"},{"language":"json","status":400,"name":"","code":"{\n    \"errors\": {\n        \"status\": \"400\",\n        \"code\": \"malformed_json\",\n        \"title\": \"could not parse request body\",\n        \"detail\": \"Could not parse request body as JSON\"\n    }\n}"},{"code":"{\n    \"errors\": {\n        \"status\": \"404\",\n        \"code\": \"file_not_found\",\n        \"title\": \"directory does not exist\",\n        \"detail\": \"Could not find the file '/foo/bar'\"\n    }\n}","language":"json","status":404},{"code":"{\n    \"errors\": {\n        \"status\": \"409\",\n        \"code\": \"dir_conflict\",\n        \"title\": \"directory already exists\",\n        \"detail\": \"Could not create '/foo/bar' as it already exists\"\n    }\n}","language":"json","status":409}]},"try":false,"basic_auth":false,"method":"post","auth":"never","params":[{"_id":"54680b5d016b480800bc7cc4","ref":"","in":"path","required":false,"desc":"An existing directory or file that will be copied","default":"","type":"string","name":"path"},{"_id":"54680b5d016b480800bc7cc3","ref":"","in":"body","required":false,"desc":"Path to copy the source item to","default":"","type":"string","name":"destination"}],"url":"/api/copy/:path"},"isReference":false,"order":11,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.post('/api/copy/foo/bar', {\\n  destination: '/foo/baz'\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"copy-file","type":"endpoint","title":"Copy File"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

path:
string
An existing directory or file that will be copied

Body Params

destination:
string
Path to copy the source item to

Result Format


Documentation

[block:code] { "codes": [ { "code": "$.post('/api/copy/foo/bar', {\n destination: '/foo/baz'\n});", "language": "javascript" } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}