Jump to Content
CAVATICASeven Bridges knowledge centerDocumentation
HomeGuidesAPI ReferenceRelease notes
v1.0

Seven Bridges knowledge centerDocumentationCAVATICA
API Reference
v1.0HomeGuidesAPI ReferenceRelease notes
All
Pages
Start typing to search…

CAVATICA API

  • API overview
  • API client library
  • List all API paths
  • Rate limit
  • Get your current rate limit status
  • User
  • Get my information
  • Users
  • List user resources
  • Billing
  • List billing API paths
  • List billing groups
  • Get a single billing group
  • 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 invoice
  • Projects
  • List all your projects
  • List projects owned by a particular user
  • Create a new project
  • Edit a project
  • Get details of a project
  • Delete 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
  • Files, folders and metadata
  • List files (primary method)
  • List files (secondary method)
  • Delete a file
  • Get file details
  • Update file details
  • Copy a file between projects
  • Copy multiple files between projects
  • Get downloadable URL for a file
  • Get a file's metadata
  • Modify a file's metadata
  • Overwrite a file's metadata
  • Create a folder
  • List folder contents
  • Copy a file between folders
  • Move a file between folders
  • Delete a file
  • Delete a folder
  • 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
  • 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 revision using raw CWL
  • Synchronize a copied app with its parent 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)
  • Volumes
  • Create a volume
  • List volumes
  • Get details of a volume
  • Update a volume
  • List the contents of a volume
  • Delete a volume
  • Get details of a file within a volume
  • Start an import job
  • Get details of an import job
  • Deactivate a volume
  • 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
  • Rerun a task
  • API status codes

FOLDERS API

  • Folders Overview

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
  • Get details of multiple tasks

ASYNC BULK ACTIONS

  • Overview
  • Copy multiple files
  • Delete multiple files and folders
  • Get details of a copy job
  • Get details of a deletion job
  • Get details of all async jobs
  • Get details of a move job
  • Move multiple files or folder

DRS API

  • Overview
  • Get info about a DRS object
  • Get an URL for downloading a file
  • Download a DRS object (file) tutorial
  • Start a bulk DRS import job
  • Get details of a bulk DRS import job

FHIR API

  • Overview
  • Start a bulk FHIR import job
  • Get details of a bulk FHIR import job

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

CAVATICA DATASETS API (Advanced Access)

  • Cavatica Datasets API Overview
  • List all datasets
  • List datasets by owner
  • Get details of a dataset
  • Get details of a dataset member
  • Edit a dataset
  • Delete a dataset
  • List members of a dataset
  • Add a dataset member
  • Remove a dataset member
  • Get a dataset member's permissions
  • Modify a dataset member's permissions
  • List dataset files

Overview

Async bulk actions allow you to perform an asynchronous operation on multiple items with a single call. The following API calls have been added:

  • Copy multiple files
  • Delete multiple files and folders
  • Get details of a deletion job
  • Get details of a copy job
  • Get details of all async jobs