Jump to Content
Guides
API
Datasets Hub
Release Notes
Home
Guides
API Reference
v1.0
Guides
API
Datasets Hub
Release Notes
CGC
API Reference
CGC
v1.0
Home
Guides
API Reference
Users
Search
JUMP TO
API Reference
List all API paths
get
User
Get my information
get
Users
List user resources
get
Billing
List billing API paths
get
List billing groups
get
Get a single billing group
get
Get analysis breakdown for a billing group
Get storage breakdown for a billing group
Get egress breakdown for a billing group
List invoices
get
Get a specific invoice
get
Projects
List all your projects
get
Create a new project
post
List projects owned by a particular user
get
Delete a project
delete
Get details of a project
get
Edit a project
patch
List members of a project
get
Add a member to a project
post
Remove a project member
delete
Get a project member's permissions
get
Modify a project member's permissions
patch
Overwrite a project member's permissions
put
Files, folders and metadata
List files (primary method)
get
List files (secondary method)
get
Delete a file
delete
Get file details
get
Update file details
patch
Add tags to a file
put
Copy a file between projects
post
Copy multiple files between projects
post
Get download information and URL for a file
get
Get a file's metadata
get
Modify a file's metadata
patch
Overwrite a file's metadata
put
Create a folder
post
List folder contents
get
Copy a file between folders
post
Move a file between folders
post
Delete a folder
delete
Delete a file
delete
Upload files
List current multipart uploads
get
Get details of a multipart upload
get
Initialize a multipart upload
post
Get upload URL for a file part
get
Report an uploaded part
post
Report uploaded parts
post
Complete a multipart upload
post
Abort a multipart upload
delete
Apps
List all apps available to you
get
Get details of an app
get
Copy an app
post
Get raw CWL for an app
get
Add an app using raw CWL
post
Get raw CWL for an app revision
get
Get details of an app revision
get
Add an app revision using raw CWL
post
Synchronize a copied app with its parent app
post
Tasks
List tasks you can access (primary method)
get
Create a new draft task
post
Delete a task
delete
Get task inputs
get
Abort a task
post
Get details of a task
get
Modify a task
patch
Get task execution details
get
Run a task
post
Modify task inputs
patch
List tasks in a project (secondary method)
get
Volumes
Create a volume
post
List volumes
get
Get details of a volume
get
List the contents of a volume
get
Get details of a file within a volume
get
Update a volume
patch
Deactivate a volume
patch
Delete a volume
delete
Start an import job
post
Get details of an import job
get
List import jobs
get
Start an export job
post
List export jobs
get
Get details of an export job
get
List members of a volume
get
Add members to a volume
post
Remove members from a volume
delete
Get a volume member's permissions
get
Overwrite a volume members' permissions
put
Modify a volume members' permissions
patch
Actions
Get file IDs
post
Get a file's download URL
post
Rate Limit
Get your current rate limit status
get
API status codes
Post a feedback item
post
Rerun a task
post
DATASETS API
Example query 1: Find samples connected to a case
post
Example query 2: Count samples connected to a case
post
Example query 3: Find cases with given age at diagnosis
post
Example query 4: Find all cases with a given age at diagnosis and a particular disease
post
Example query 5: Complex example for filtering TCGA data
post
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 samples
post
BULK API ACTIONS
Bulk features overview
Start a bulk import job
post
Get details of a bulk import job
post
Start a bulk export job
post
Get details of a bulk export job
post
Bulk deletion of files
post
Get details of multiple files
post
Update details of multiple files
post
Edit details of multiple files
post
Get details of multiple tasks
post
DRS API
Overview
Get info about a DRS object
get
Get a URL for downloading a file
get
Download a DRS object (file) tutorial
Start a bulk DRS import job
post
Get details of a bulk DRS import job
get
Users
The following API call governs user resources:
List user resources
