GuidesAPI ReferenceRelease NotesTutorials

Delete a project

projects/{project_owner}/{project}

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

https://api.sb.biodatacatalyst.nhlbi.nih.gov/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: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X DELETE -H "X-SBG-Auth-Token: ce7ae5ab85e946599298e88a3430fba0" 'http://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/my-project'

Header Fields

NameDescription
X-SBG-Auth-Token
required		Your Platform 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 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