List all apps available to you

/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 apps

Note that you can see all of the publicly available apps on CAVATICA by setting the query parameter visibility to public. If you omit this parameter, you will see all your private apps, 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: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/apps"

Header Fields

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

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.
projectstringEnter a project, in the form {project_owner}/{project_short_name} to restrict the results to apps from that project only.
project_ownerstringEnter 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.
visibilitystringSet this to public to see all public apps on CAVATICA.

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"
    },
  ]
}

Language