Seven Bridges knowledge centerDocumentation
API Reference

List dataset files

get https://cavatica-api.sbgenomics.com/v2

❗️

Heads Up!

This page documents the Advanced Access version (think "beta" but with fewer bugs) of the Datasets API functionality.

This call lists all files in a specified dataset.

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

Request

Example request

GET v2/files?dataset=rfranklin/target-aml-pa-01
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
X-SBG-advance-access: advance

curl -X GET -H "X-SBG-Auth-Token: 5f2d7a4d8186488694fa3dc3844b7b06" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" "https://cavatica-api.sbgenomics.com/v2/files?dataset=rfranklin/target-aml-pa-01"

Header fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.
X-SBG-Advance-Access
required		advance

Query parameters

NameData typeDescription
<dataset/owner>
required 		stringThe name of the dataset you are querying, followed by the owner of the dataset.

Response

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

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/v2/files?offset=0&limit=25&dataset=rfranklin/target-aml-pa-01",
  "items": [
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/files/568cf5dce4b0307bc0462060",
      "id": "568cf5dce4b0307bc0462060",
      "name": "1000G_phase1.indels.b37.vc",
      "dataset": "rfranklin/target-aml-pa-01"
           },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80",
      "id": "566aad1de4b0c560b469ea80",
      "name": "1000G_omni2.5.b37.vcf",
      "dataset": "rfranklin/target-aml-pa-01"
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/files/568cf5f4e4b0307bc0462062",
      "id": "568cf5f4e4b0307bc0462062",
      "name": "1000G_phase1.snps.high_confidence.b37.vcf",
      "dataset": "rfranklin/target-aml-pa-01"
    }
  ],
  "links": []
 
}
Language