GuidesAPIDatasets HubRelease Notes
API Reference
CGC

Delete a project

delete https://cgc-api.sbgenomics.com/v2

projects/{project_owner}/{project}

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

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

❗️

Warning

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

👍

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: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X DELETE 'http://gc-api.sbgenomics.com//v2/projects/RFranklin/my-project'

Header Fields

NameDescription
X-SBG-Auth-Token
required		Your CGC authentication token.

Path parameters

NameDescription
projectThe short name of the project you are deleting.
project_ownerThe owner of the project you are deleting.

Response

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

HTTP/1.1 204 No Content
Date: Tue, 29 Mar 2016 15:47:44 GMT
Connection: close
Language