Skip to content
Docs
Deploy
Submit
User Roles
Explore
Technical
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Deployment
Local deployment
Production deployment
Testing
Interact using Make
Logging
Back up/Restore
Troubleshooting
Update CanDIG
GitHub
Select theme
Dark
Light
Auto
Data submission steps
Prepare clinical data
Registering programs
Ingest clinical data
Prepare genomic data
Ingest genomic data
Troubleshooting
GitHub
Select theme
Dark
Light
Auto
Exploring data on the portal
Summary Dashboard
Querying data in CanDIG
Completeness in CanDIG
GitHub
Select theme
Dark
Light
Auto
User Roles
Roles Overview
Assign user roles
DAC Authorization
GitHub
Select theme
Dark
Light
Auto
Tech docs
Architecture
Docker and submods
ingest api
Overview
Operations
Retrieve information about this service
Add credentials for an S3 bucket
get credentials for an S3 bucket
delete credentials for an S3 bucket
List users in role_type
Is user in this role?
Assign user to role
Remove user from role
List registered programs
Add authorization information for a new program (or overwrite authorization information for an existing program).
Get authorization information for a program
ingest_operations.remove_program
Get a program's DAC authorizations
Add pending user
List pending users
Approve pending users
Delete pending users
Is a user pending?
Approve pending user
Reject pending user
List preapproved users
Add preapproved users
Delete preapproved users
Check preapproved list for user
Add preapproved user
Remove preapproved user
List authorization information about a user
Revoke CanDIG authorization for a user
Authorize a program for a user
Get a DAC authorization for a user
Remove a DAC authorization for a user
Ingest CanDIG data
Ingest CanDIG data
Ingest CanDIG data
Check status of ingest
Get a new token
query api
Overview
Operations
Retrieve information about this service
Retrieve patients matching the filters
Retrieve summary statistics on genomic data
Retrieve summary statistics on the metadata for each program, as well as the current site.
Retrieve summary statistics on the metadata for each program that match the given query parameters.
Get discovery overview endpoint calls
Retrieve the user key (usually the email) for the currently logged-in user
katsu api
Overview
authorized
List Biomarkers
List Comorbidities
Get Donor With Clinical Data
List Donors
List Exposures
List Follow Ups
List Primary Diagnoses
List Programs
Query Donors
List Radiations
List Sample Registrations
List Specimens
List Surgeries
List Systemic Therapies
List Treatments
overview
Discover Diagnosis Age Count
Discover Gender Count
Discover Individual Count
Discover Patients Per Program
Discover Primary Site Count
Discover Program Count
Discover Treatment Type Count
discovery
Discover Programs
Discover Sidebar List
download
Search Clinical Data
explorer
Explorer Donor
ingest
Create Biomarkers
Create Comorbidities
Create Donors
Create Exposures
Create Followups
Create Primary Diagnoses
Create Programs
Create Radiations
Create Sample Registrations
Create Specimens
Create Surgeries
Create Systemic Therapies
Create Treatments
delete
Delete Program
Operations
Service Info
drs api
Overview
Operations
Retrieve information about this service
Add a DrsObject to the db
Delete a DrsObject.
drs_operations.list_programs
drs_operations.post_program
drs_operations.get_program
Delete a program.
drs_operations.get_program_status
Objects
List all DRS objects
Get info about a DrsObject.
Download a file associated with a drs object
Get a URL for fetching bytes
List all DRS Experiment objects matching an array of submitter_sample_ids. Only authorized for site admins and authzed services.
htsget beacon api
Overview
Informational endpoints
beacon_operations.get_beacon_service_info
Operations
beacon_operations.get_full_result
GET Endpoints
beacon_operations.get_search
POST Endpoints
beacon_operations.post_search
htsget operations api
Overview
Reads
Get reads service info
Get alignment (reads) file download ticket
Stream alignment file part
Variants
Get variants service info
Get variant file download ticket
Stream variant file part
Service Info
Get reads service info
Get variants service info
Streaming
Stream alignment file part
Stream variant file part
Operations
htsget_operations.indexer_status
htsget_operations.indexer_switch
Verify the integrity of the object
Index variant file for search
List all available gene names
Get transcript region for genes matching id
List all available gene names
Get transcript region for transcripts matching id
Get metadata about a experiment
Get metadata about experiments in a program
Get metadata about multiple experiments
federation api
Overview
Operations
operations.service_info
operations.list_servers
operations.add_server
operations.get_server
operations.delete_server
operations.list_external_services
operations.add_external_service
operations.get_external_service
operations.delete_external_service
operations.list_services
operations.add_service
operations.get_service
operations.delete_service
Send a request to the CanDIG network
GitHub
Select theme
Dark
Light
Auto
operations.list_external_services
GET
/external-service
List external service.
Responses
200
Successful query
500
Internal Error
