{"_id":"54680584016b480800bc7ca0","githubsync":"","order":0,"updates":[],"__v":0,"api":{"try":false,"url":"/api/dir/:path","auth":"never","basic_auth":false,"method":"get","params":[{"type":"string","in":"path","_id":"54680584016b480800bc7ca1","default":"","desc":"Path to an existing directory that you want to get the contents of","name":"path","required":false}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"data\":[\n    {\n      \"name\":\"about.md\",\n      \"path\":\"/about.md\",\n      \"isDir\":false,\n      \"size\":1231,\n      \"modTime\":1415837672\n    },\n    {\n      \"name\":\"bio.md\",\n      \"path\":\"/bio.md\",\n      \"isDir\":false,\n      \"size\":1889,\n      \"modTime\":1415931913\n    },\n    {\n      \"name\":\"contact.md\",\n      \"path\":\"/contact.md\",\n      \"isDir\":false,\n      \"size\":517,\n      \"modTime\":1415837672\n    },\n    {\n      \"name\":\"gallery\",\n      \"path\":\"/gallery\",\n      \"isDir\":true,\n      \"size\":442,\n      \"modTime\":1416298837\n    },\n    {\n      \"name\":\"process\",\n      \"path\":\"/process\",\n      \"isDir\":true,\n      \"size\":204,\n      \"modTime\":1416298831\n    }\n  ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"code\": 404,\n  \"status\": \"Not Found\",\n  \"message\": \"Directory does not exist\"\n}","name":""}]}},"createdAt":"2014-11-16T02:01:40.626Z","excerpt":"","category":"5467f78698b68408002689f8","editedParams2":true,"hidden":false,"user":"5467f76e016b480800bc7c7d","project":"5467f78598b68408002689f4","slug":"read-directory","version":"5467f78598b68408002689f7","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('/api/dir/foo');\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","editedParams":true,"is_link":false,"link_url":"","type":"get","link_external":false,"sync_unique":"","title":"Read Directory","childrenPages":[]}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

path:
string
Path to an existing directory that you want to get the contents of

Result Format


Documentation

[block:code] { "codes": [ { "code": "$.get('/api/dir/foo');", "language": "javascript" } ] } [/block]

User Information

Try It Out

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