List files (primary method)

get

https://api.sbgenomics.com/v2/files

This call returns a list of files and subdirectories in a specified project or directory within a project, with specified properties that you can access. The project or directory whose contents you want to list is specified as a query parameter in the call. Further properties to filter by can also be specified as query parameters.

Note that this call lists both files and subdirectories in the specified project or directory within a project, but not the contents of the subdirectories. To list the contents of a subdirectory, make a new call and specify the subdirectory ID as the parent parameter.

Don't forget that projects on the Platform are specified by their short names.

Further file properties to filter by can also be specified as query parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/files

👍
File IDs
The file IDs returned by this call are useful for issuing further queries to get more information about a particular file.

🚧
Alias call
There is a second method for listing files in a project: GET projects/{project_owner}/{project_name}/files. The call listed here is the primary and preferred method for performing this operation.

👍
Tips for filtering
When filtering on any resource, including the same field several times with different filtering criteria results in an implicit OR operation for that field and the different criteria.
When filtering by different specified fields, an implicit AND is performed between those criteria. Thus, the call in Example 3 above would return files matching the specified project AND sample ID AND library.

📘
List files in the Public Reference Files repository
The Seven Bridges Public Reference Files repository is specified in the same way as a project on the Platform by an id of admin/sbg-public-data. You can pass this query parameter using project=admin/sbg-public-data.

👍
Limit your results
Don't forget that you can use the pagination query parameter limit to restrict the number of files returned by this call.

👍
Set the query parameter fields to _all to display tags within the response body, since tags is not automatically displayed in the response body.

Query Params

project

string

Required if parent is not used. Project is specified in the following format: {project_owner}/{project}. project_owner is the owner of the project you are listing files from, while project is the project's short name. Project ID should not be used together with parent. If parent is used, the call will list the content of the specified folder, within the project to which the folder belongs. If project is used, the call will list the content at the root of the project's files.

parent

string

Required if project is not used. ID of the folder whose content you want to list. Should not be used together with project. If parent is used, the call will list the content of the specified folder, within the project to which the folder belongs. If project is used, the call will list the content at the root of the project's files.

name

string

List file with this name. Note that the name must be an exact complete string for the results to match. Multiple names can be separated by an OR operation. The OR operation is implied when the same parameter is queried multiple times in the same API request.

metadata.{field}

string

List only files with that have the specified value in metadata field. Multiple instances of the same metadata field are implicitly separated by an OR operation. Conversely, different metadata fields are implicitly separated by an AND operation.

origin.task

string

List only files produced by task specified by ID in this field.

tag

string

List files containing this tag. Note that the tag must be an exact complete string for the results to match. Multiple tags can be separated by an OR operation. The OR operation is implied when the same parameter is queried multiple times in the same API request. Keep in mind that tags are different from metadata. Learn more about tagging your files on the Platform.

Headers

X-SBG-Auth-Token

string

required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

File IDs

Alias call

Tips for filtering

List files in the Public Reference Files repository

Limit your results

200200