Edit a project

projects/{project_owner}/{project}

This call edits the details of a project on the Platform. You can use it to change the name, description, or billing group of the project.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/{project_owner}/{project}

👍

Referring to your project

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

##Request

Example request

HTTP

PATCH /v2/projects/RFranklin/sandbox HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl  --data '{"name": "New name for my project", "description": "Updated with the results of the latest experiments"}' -s -H "X-SBG-Auth-Token: 1e43fEXampLEa5523dfd14exAMPle3e5" -H "content-type: application/json" -X PATCH "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/sandbox"

Request body

The request body should contain a set of key-value pairs. The keys, and the values they take, are described in the following table. Enter a key-value pair if you want to re-set the existing value for the project.

📘

Changing a project's name

Note that once the project has been created, you cannot change its short name. However, you can edit a project's given name at any time using the call on this page.

Key	Datatype of value	Description of value
name	string	The name of the project you are editing.
billing_group	string	The ID of the billing group for the project. List all billing groups to locate your billing group ID.
description	string	A description of the project.
settings	dictionary	This dictionary contains one field, locked.
locked	Boolean	This field can be true or false. Set this field to true to lock down a project. Locking down a project prevents any Seven Bridges team member from viewing any information about the task.
use_interruptible_instances	Boolean	This field can be true or false. Set this field to true to allow the use of spot instances.
allow_network_access	Boolean	Allows you to control network access for executions within the project.

👍

Controlled Data project versus Open Data project

Note that you can change a project's name, billing group, and description, but you can't change whether or not it is a Controlled Data project after the project has been created.

Example request body

JSON

{
    "name": "New name for my project",
    "description": "Updated with the results of the latest experiments",
  	"settings": {
        "locked":true
        "use_interruptible_instances": true,
        "allow_network_access": true
    }
}

Header Fields

Name	Description
X-SBG-Auth-Token required	Your Platform authentication token.

Path parameters

Name	Description
project	The short name of the project you are editing.
project_owner	The owner of the project you are editing.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.

Response

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

Example response body

JSON

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/sandbox",
  "id": "RFranklin/sandbox",
  "name": "New name for my project",
  "type": "v2",
  "description": "Updated with the results of the latest experiments",
  "tags": [],
  "settings": {
        "locked": true,
        "use_interruptible_instances": false,
        "allow_network_access": true
    },
  "billing_group": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7"
}