/apps
For general information on the API, including formatting, parameters, and pagination, please see the API Overview.
This call lists all the apps available to you.
https://cavatica-api.sbgenomics.com/v2/apps
Public/private appsNote that you can see all of the publicly available apps on CAVATICA by setting the query parameter
visibilitytopublic. If you omit this parameter, you will see all yourprivateapps, i.e. those in projects that you can access. Learn more about public apps in our documentation.
Request
Example request
GET /v2/apps HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/apps"Header Fields
Name | Description |
|---|---|
| Your CAVATICA authentication token. |
Query parameters
Name | Data type | Description |
|---|---|---|
| string | Selector specifying a subset of fields to include in the response. |
| string | Enter a project, in the form |
| string | Enter a CAVATICA username to restrict the results to apps from that user's projects only. Note that you can only see apps within projects that you are a member of. |
| string | Set this to |
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/apps/",
"items": [
{
"href": "https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/workflow",
"id": "RFranklin/my-project/workflow",
"name": "workflow"
},
{
"href": "https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/fusion-transcript-detection-chimerascan",
"id": "RFranklin/my-project/fusion-transcript-detection-chimerascan",
"name": "fusion-transcript-detection-chimerascan"
},
{
"href": "https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/somaticsniper-filters",
"id": "RFranklin/my-project/somaticsniper-filters",
"name": "somaticsniper-filters"
},
{
"href": "https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/command-line-tool",
"id": "RFranklin/my-project/command-line-tool",
"name": "command-line-tool"
},
{
"href": "https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/delly2-workflow",
"id": "RFranklin/my-project/delly2-workflow",
"name": "delly2-workflow"
},
]
}