Remove members from a volume

This call removes members from a specific volume. The volume is specified as volume_id and consists of the owner and name of a volume (for example rfranklin/my-first-volume).

Request

https://api.sbgenomics.com/v2/storage/volumes/{volume_id}/members/{username}
https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_id}/members/{username}

Example request

DELETE /v2/storage/volumes/rfranklin/my-first-volume/members/jsmith HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-type: application/json" -X DELETE "https://api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/members/{username}"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74')

volume = api.volumes.get(id='rfranklin/my-first-volume')

# send DELETE request to SB API
volume.remove_member(user='crickandwatson')

Header Fields

Key

Description of value

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-type
required

application/json

Path parameters

Key

Data type of value

Description of value

volume_id
required

String

The volume that you want to query, which consists of username of the volume owner and volume name, for example rfranklin/my-first-volume.

username

String

Enter the username of the project member you'd like to remove from a volume.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

If the request executed properly, there will be no response body for this request.