List files (secondary method)

/files

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call lists the files in the specified project. It is an alias for the call GET /files and redirects to that path.

❗️

Alias call

Note that since this is an alias for another call, the call cannot be made directly from all applications. In particular, to send the call using cURL, use the cURL option -L to redirect the path of this call to `https://cavatica-api.sbgenomics.com/v2/files?{project_owner}/{project}.

Alternatively, to list all files, you can simply use the call GET /files.

https://cavatica-api.sbgenomics.com/v2/projects/{project_owner}/{project}/files

Request

Example request

👍

Referring to your project

Note that project_owner is always case-sensitive, and that project is not the project's name but its ID, or short name. For full details of identifying objects using the API, please see the API overview.

GET /v2/projects/rfranklin/my-project/files HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -L "https://api.sbgenomics.com/v2/files?RFranklin/my-project"  -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project/files"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Path parameters

Name

Description

project

The short name of the project you are querying.

project_owner

The owner of the project you are querying.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

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&project=RFranklin/my-project",
  "items": [
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/files/567890abc9b0307bc0414164",
      "id": "567890abc9b0307bc0414164",
      "name": "my_reference.vcf",
      "project": "RFranklin/my-project"
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/files/567890abc1e5339df0414123",
      "id": "567890abc1e5339df0414123",
      "name": "_1_unsorted.bam",
      "project": "RFranklin/my-project"
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/files/567890abc4f3066bc3750174",
      "id": "567890abc4f3066bc3750174",
      "name": "unsorted.bam",
      "project": "RFranklin/my-project"
    }
  ],
  "links": []
}

Language
Click Try It! to start a request and see the response here!