Delete a project

/projects/{project_owner}/{project}

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call deletes a project from CAVATICA. It can only be successfully made if you have admin status for the project.

https://cavatica-api.sbgenomics.com/v2/projects/{project_owner}/{project}

❗️

Warning

Deleting a project completely erases the project and any of its related data from CAVATICA.

👍

Referring to your project

Note that project_owner is always case-sensitive, and that project is not the project's name but its short name. For full details of identifying objects using the API, please see the API Overview

##Request

Example request

DELETE /v2/projects/RFranklin/my-project HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X DELETE 'http://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project'

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Path parameters

Name

Description

project

The short name of the project you are deleting.

project_owner

The owner of the project you are deleting.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response.


Language
Click Try It! to start a request and see the response here!