Users

Get a Specific Share's Authorized Users

* This can only be accessed by managers that have manager access on this particular Share

GET/api/v1/data/shares/:share_id/user_permissions
Authorization: Basic
Response Format: JSON

Response



Get a Specific Share's Authorized User

GET/api/v1/data/shares/:share_id/user_permissions/:user_id
Authorization: Basic
Response Format: JSON

Response



Authorize a User to a Share

POST/api/v1/data/shares/:share_id/user_permissions
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • user_id (required)
  • browse_permission (boolean)
  • download_permission (boolean)
  • mkdir_permission (boolean)
  • delete_permission (boolean)
  • rename_permission (boolean)
  • content_availability_permission (boolean)
  • manage_permission (boolean)

Response




Update a User's Authorization to a Share

PUT/api/v1/data/shares/:share_id/user_permissions/:user_id
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • browse_permission (boolean)
  • download_permission (boolean)
  • mkdir_permission (boolean)
  • delete_permission (boolean)
  • rename_permission (boolean)
  • content_availability_permission (boolean)
  • manage_permission (boolean)

Response



Delete a User's Authorization to a Share

DELETE/api/v1/data/shares/:share_id/user_permissions/:user_id
Authorization: Basic
Response Format: JSON

Groups

Get a Specific Share's Authorized Groups

* This can only be accessed by managers that have manager acces on this particular Share

GET/api/v1/data/shares/:share_id/group_permissions
Authorization: Basic
Response Format: JSON

Response



Get a Specific Share's Authorized Group

GET/api/v1/data/shares/:share_id/group_permissions/:group_id
Authorization: Basic
Response Format: JSON

Response



Authorize a Group to a Share

POST/api/v1/data/shares/:share_id/group_permissions
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • group_id (required)
  • browse_permission (boolean)
  • download_permission (boolean)
  • mkdir_permission (boolean)
  • delete_permission (boolean)
  • rename_permission (boolean)
  • content_availability_permission (boolean)
  • manage_permission (boolean)

Response




Update a Group's Authorization to a Share

PUT/api/v1/data/shares/:share_id/group_permissions/:group_id
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • browse_permission (boolean)
  • download_permission (boolean)
  • mkdir_permission (boolean)
  • delete_permission (boolean)
  • rename_permission (boolean)
  • content_availability_permission (boolean)
  • manage_permission (boolean)

Response



Delete a Group's Authorization to a Share

DELETE/api/v1/data/shares/:share_id/group_permissions/:group_id
Authorization: Basic
Response Format: JSON

Shares

Get Shares

GET/api/v1/data/shares
Authorization: Basic
Response Format: JSON

Response



Get Specific Share

GET/api/v1/data/shares/:id
Authorization: Basic
Response Format: JSON

Response



Create a Share

POST/api/v1/data/shares
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • node_id (required)
  • name (required)
  • directory (required)
  • create_directory* (boolean | default: false)

* Use to create the directory on the node if it doesn't exist

Response



Update a Share

PUT/api/v1/data/shares/:id
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • node_id
  • name
  • directory

Response



Delete a Share

DELETE/api/v1/data/shares/:id
Authorization: Basic
Response Format: JSON

Video player

Video

×