Update share
PATCH /shares/{shid}
Changes name and/or description of the share.
Example cURL requests
Change name of the share
curl -H "X-Auth-Token: $TOKEN" -X PATCH "https://$HOST/api/v3/oneprovider/shares/$SHARE_ID" \
-H "Content-Type: application/json" -d '{
"name": "NewShareName",
"description": "# New description"
}'
Path parameters
| Parameter | Type & Description |
|---|---|
| shid required | string Share Id (e.g. '1f4b762b1380946e73aeca574c77f14c') |
Request body
application/json
New share details
Property
Type & Description
name
string
New name for the share.
description
string
New description of the share.
Request Examples
Shell
oneprovider-rest-cli updateShare shid=$SHARE_ID name==NewShareName description=="# New description"Responses
application/json
204
Share's name has been changed.
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."
}