List Shares API
Request Info
Info |
Value |
Request URL |
/shares |
Request VERB |
GET |
Response Parameters
Parameter |
Type |
Description |
id |
String |
The Unique ID for the share. |
name |
String |
The Name of the Share. |
access |
String |
'read' or 'write' depending on if the API user has read or write access to the share. |
view_log |
Boolean |
true if the user can view the share log. |
created_at |
DateTime |
When the share was created |
update_at |
DateTime |
When the share was last updated |
Example Request in JSON
curl -X GET -H "Accept: application/json" -H "Content-Type: application/json" --user nkpIxMK9ucUUE7FvfNpdAf:x https://test.host/shares
Example Response in JSON
{"shares":
[
{
"id":"test",
"name":"Test Share",
"access":"read",
"view_log":false,
"created_at":"2016-02-01T09:11:23.000Z",
"updated_at":"2017-01-05T08:49:29.000Z"
},
{
"id":"project-alpha",
"name":"Project Alpha",
"access":"write",
"view_log":true,
"created_at":"2017-01-05T09:48:14.000Z",
"updated_at":"2017-01-05T09:48:14.000Z"
}
]
}