Jump to Content

Seven Bridges knowledge center Documentation

Home Guides API Reference Release notes

v1.0

Seven Bridges knowledge center Documentation

API Reference

v1.0Home Guides API Reference Release notes

All

Guides

Reference

Release notes

Start typing to search…

CAVATICA API

API overview
API client library
List all API pathsget
Rate limit
Get your current rate limit statusget
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
List projects owned by a particular userget
Create a new projectpost
Edit a projectpatch
Get details of a projectget
Delete a projectdelete
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
Copy a file between projectspost
Copy multiple files between projectspost
Get downloadable 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 filedelete
Delete a folderdelete
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
Update a volumepatch
List the contents of a volumeget
Delete a volumedelete
Get details of a file within a volumeget
Start an import jobpost
Get details of an import jobget
Deactivate a volumepatch
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
Rerun a taskpost
API status codes

FOLDERS API

Folders Overview

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

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 datasetsget
List datasets by ownerget
Get details of a datasetget
Get details of a dataset memberget
Edit a datasetpatch
Delete a datasetdelete
List members of a datasetget
Add a dataset memberpost
Remove a dataset memberdelete
Get a dataset member's permissionsget
Modify a dataset member's permissionsput
List dataset filesget

Rate limit

The following API call allows you to get your rate limit.

Get your current rate limit status

Updated less than a minute ago

List all API paths

Get your current rate limit status

Did this page help you?

Updated less than a minute ago

List all API paths

Get your current rate limit status

Did this page help you?

CAVATICA API
API overview
API client library
List all API pathsget
Rate limit
Get your current rate limit statusget
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
List projects owned by a particular userget
Create a new projectpost
Edit a projectpatch
Get details of a projectget
Delete a projectdelete
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
Copy a file between projectspost
Copy multiple files between projectspost
Get downloadable 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 filedelete
Delete a folderdelete
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
Update a volumepatch
List the contents of a volumeget
Delete a volumedelete
Get details of a file within a volumeget
Start an import jobpost
Get details of an import jobget
Deactivate a volumepatch
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
Rerun a taskpost
API status codes

FOLDERS API
Folders Overview

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

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 datasetsget
List datasets by ownerget
Get details of a datasetget
Get details of a dataset memberget
Edit a datasetpatch
Delete a datasetdelete
List members of a datasetget
Add a dataset memberpost
Remove a dataset memberdelete
Get a dataset member's permissionsget
Modify a dataset member's permissionsput
List dataset filesget