Jump to Content
BioData Catalyst powered by Seven Bridges Knowledge CenterGuidesAPI ReferenceRelease NotesTutorials
API Reference
GuidesAPI ReferenceRelease NotesTutorialsBioData Catalyst powered by Seven Bridges Knowledge Center
API Reference

API Reference

  • List all API paths
  • User
    • Get my information
  • Users
    • List user resources
  • Billing
    • Get a specific invoice
    • List invoices
    • Get analysis breakdown for a billing group
    • Get storage breakdown for a billing group
    • Get egress breakdown for a billing group
    • Get a single billing group
    • List billing groups
    • List billing API paths
  • Projects
    • List all your projects
    • Create a new project
    • List projects owned by a particular user
    • Delete a project
    • Get details of a project
    • Edit a project
    • List members of a project
    • Add a member to a project
    • Remove a project member
    • Get a project member's permissions
    • Modify a project member's permissions
    • Overwrite a project member's permissions
    • Edit a project's settings
  • Files and metadata
    • List files (primary method)
    • List files (secondary method)
    • Delete a file
    • Get file details
    • Update file details
    • Add tags to a file
    • Copy a file
    • Get download information and URL for a file
    • Get a file's metadata
    • Modify a file's metadata
    • Overwrite a file's metadata
    • Change file details
    • Copy files between projects
  • Upload files
    • List current multipart uploads
    • Get details of a multipart upload
    • Initialize a multipart upload
    • Get upload URL for a file part
    • Report an uploaded part
    • Report uploaded parts
    • Complete a multipart upload
    • Abort a multipart upload
  • Apps
    • Copy an app
    • Get details of an app
    • List all apps available to you
    • 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 revision using raw CWL
    • Synchronize a copied app with its parent app
    • List all apps in a user's projects
    • List all apps in a specific project
    • Copy all apps in a specific project
    • Get the latest version of an app
    • Install a new CWL app
    • Create a new revision of an app
  • Tasks
    • List tasks you can access (primary method)
    • Create a new draft task
    • Delete a task
    • Get task inputs
    • Abort a task
    • Get details of a task
    • Modify a task
    • Get task execution details
    • Run a task
    • Modify task inputs
    • List tasks in a project (secondary method)
    • Change details of a task
  • Volumes
    • Create a volume
    • Get details of a volume
    • List the contents of a volume
    • Get details of a file within a volume
    • Update a volume
    • Deactivate a volume
    • Delete a volume
    • Start an import job
    • Get details of an import job
    • List import jobs
    • Start an export job
    • List export jobs
    • Get details of an export job
    • List members of a volume
    • Add members to a volume
    • Remove members from a volume
    • Get a volume member's permissions
    • Overwrite a volume members' permissions
    • Modify a volume members' permissions
    • Leave a volume
  • Actions
    • Copy files between projects
    • Get file IDs
    • Get a file's download URL
  • Rate Limit
    • Get your current rate limit status
  • API status codes
  • Post a feedback item

FOLDERS API

  • Folders Overview
  • Create a folder
  • List folder contents
  • Copy a file between folders
  • Move a file between folders
  • Delete a file
  • Delete a folder

BULK API ACTIONS

  • Bulk features overview
  • Start a bulk import job
  • Get details of a bulk import job
  • Start a bulk export job
  • Get details of a bulk export job
  • Bulk deletion of files
  • Get details of multiple files
  • Update details of multiple files
  • Edit details of multiple files

GA4GH

  • DRS API Overview
    • Get info about a DRS object
    • Get an URL for downloading a file
    • Download a DRS object (file) tutorial
  • WES API Overview
    • Run a workflow
    • Cancel a running workflow
    • Get the status of the workflow run
    • Get details of a workflow run
    • List workflow runs
    • Get service information

Upload files

These API calls below allow you to initiate, perform and control uploads of files to your projects on the Platform.

List current multipart uploads
Get details of a multipart upload
Initialize a multipart upload
Get upload URL for a file part
Report an uploaded part
Report uploaded parts
Complete a multipart upload
Abort a multipart upload