Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Remove share

DELETE /shares/{shid}

Removes a specific share. This operation will not remove data from shared file or directory but it will not be accessible through public url anymore.

Example cURL requests

Remove share

curl -H "X-Auth-Token: $TOKEN" \
-X DELETE "https://$HOST/api/v3/oneprovider/shares/$SHARE_ID"

Path parameters

Parameter Type & Description
shid required
string

Share Id (e.g. '1f4b762b1380946e73aeca574c77f14c')

Request Examples

Shell
oneprovider-rest-cli removeShare shid=$SHARE_ID

Responses

application/json
204

Share has been removed.

400

Invalid request.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
403

Forbidden request.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
404

Share not found.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
500

Internal server error.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}