get https://cgc-api.sbgenomics.com/v2/storage/volumes//list
This call lists the contents of 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
Example request
Header Fields
Key | Description of value |
---|---|
X-SBG-Auth-Token required | Your CGC 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 . |
Query parameters
Key | Data type of value | Description of value |
---|---|---|
fields | String | Selector specifying a subset of fields to include in the response. |
Here's the list of available values for the fields
parameter and their descriptions:
Value | Description |
---|---|
href | Shows only the href of each returned item. |
location | Shows only the location (path) within the volume for each returned item. |
volume | Shows only the volume on which the returned item is located, in the <user-name>/<volume-name> format. |
type | Shows only the type of the returned item. Type is s3 for items stored on an AWS S3 bucket and gcp for items stored on a Google Cloud Storage bucket. |
metadata | Shows only the storage-provider-generated metadata for each of the returned items. |
_all | Shows all standard fields for each returned item, with the addition of corresponding metadata. |
Response
See a list of CGC-specific response codes that may be contained in the body of the response.
Example response body
Interpreting the response body
href
: Use the information contained in thehref
to make another request to obtain more details about a specific object within a volume.