List the contents of a volume

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).

📘

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}/list

Here's the list of available values for the fields query 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 Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Interpreting the response body

  • href: Use the information contained in the href to make another request to obtain more details about a specific object within a volume.
Language