Jump to Content
The CGC Knowledge CenterGuidesAPIDatasets HubRelease Notes
HomeGuidesAPI Reference
v1.0

GuidesAPIDatasets HubRelease NotesCGCThe CGC Knowledge Center
API Reference
CGC
v1.0HomeGuidesAPI Reference

API Reference

  • List all API pathsget
  • User
  • Get my informationget
  • Users
  • List user resourcesget
  • Billing
  • List billing API pathsget
  • List billing groupsget
  • Get a single billing groupget
  • Get analysis breakdown for a billing group
  • Get storage breakdown for a billing group
  • Get egress breakdown for a billing group
  • List invoicesget
  • Get a specific invoiceget
  • Projects
  • List all your projectsget
  • Create a new projectpost
  • List projects owned by a particular userget
  • Delete a projectdelete
  • Get details of a projectget
  • Edit a projectpatch
  • List members of a projectget
  • Add a member to a projectpost
  • Remove a project memberdelete
  • Get a project member's permissionsget
  • Modify a project member's permissionspatch
  • Overwrite a project member's permissionsput
  • Files, folders and metadata
  • List files (primary method)get
  • List files (secondary method)get
  • Delete a filedelete
  • Get file detailsget
  • Update file detailspatch
  • Add tags to a fileput
  • Copy a file between projectspost
  • Copy multiple files between projectspost
  • Get download information and URL for a fileget
  • Get a file's metadataget
  • Modify a file's metadatapatch
  • Overwrite a file's metadataput
  • Create a folderpost
  • List folder contentsget
  • Copy a file between folderspost
  • Move a file between folderspost
  • Delete a folderdelete
  • Delete a filedelete
  • Upload files
  • List current multipart uploadsget
  • Get details of a multipart uploadget
  • Initialize a multipart uploadpost
  • Get upload URL for a file partget
  • Report an uploaded partpost
  • Report uploaded partspost
  • Complete a multipart uploadpost
  • Abort a multipart uploaddelete
  • Apps
  • List all apps available to youget
  • Get details of an appget
  • Copy an apppost
  • Get raw CWL for an appget
  • Add an app using raw CWLpost
  • Get raw CWL for an app revisionget
  • Get details of an app revisionget
  • Add an app revision using raw CWLpost
  • Synchronize a copied app with its parent apppost
  • Tasks
  • List tasks you can access (primary method)get
  • Create a new draft taskpost
  • Delete a taskdelete
  • Get task inputsget
  • Abort a taskpost
  • Get details of a taskget
  • Modify a taskpatch
  • Get task execution detailsget
  • Run a taskpost
  • Modify task inputspatch
  • List tasks in a project (secondary method)get
  • Volumes
  • Create a volumepost
  • List volumesget
  • Get details of a volumeget
  • List the contents of a volumeget
  • Get details of a file within a volumeget
  • Update a volumepatch
  • Deactivate a volumepatch
  • Delete a volumedelete
  • Start an import jobpost
  • Get details of an import jobget
  • List import jobsget
  • Start an export jobpost
  • List export jobsget
  • Get details of an export jobget
  • List members of a volumeget
  • Add members to a volumepost
  • Remove members from a volumedelete
  • Get a volume member's permissionsget
  • Overwrite a volume members' permissionsput
  • Modify a volume members' permissionspatch
  • Actions
  • Get file IDspost
  • Get a file's download URLpost
  • Rate Limit
  • Get your current rate limit statusget
  • API status codes
  • Post a feedback itempost
  • Rerun a taskpost

DATASETS API

  • Example query 1: Find samples connected to a casepost
  • Example query 2: Count samples connected to a casepost
  • Example query 3: Find cases with given age at diagnosispost
  • Example query 4: Find all cases with a given age at diagnosis and a particular diseasepost
  • Example query 5: Complex example for filtering TCGA datapost
  • Example query 6: Find TCGA cases with or without a prior diagnosis and related samples from a particular tissue source site and return the sample type code for each of these samplespost

BULK API ACTIONS

  • Bulk features overview
  • Start a bulk import jobpost
  • Get details of a bulk import jobpost
  • Start a bulk export jobpost
  • Get details of a bulk export jobpost
  • Bulk deletion of filespost
  • Get details of multiple filespost
  • Update details of multiple filespost
  • Edit details of multiple filespost
  • Get details of multiple taskspost

DRS API

  • Overview
  • Get info about a DRS objectget
  • Get a URL for downloading a fileget
  • Download a DRS object (file) tutorial
  • Start a bulk DRS import jobpost
  • Get details of a bulk DRS import jobget

Apps

These API calls below allow you to manage apps on the CGC. Supported operations include listing apps in a given project, and in public apps. You can also copy apps between projects.

List all apps available to you
Get details of an app
Copy an app
Get raw CWL for an app
Add an app using raw CWL
Get raw CWL for an app revision
Get details of an app revision
Add an app using raw CWL