Edit a project

patch

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

This call edits a project on the Seven Bridges Platform. As a project Admin you can use it to change the name, settings, tags or billing group of the project.

Users with write permissions in the project can change the project description.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Path for Seven Bridges Platform EU
If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/projects/{project_owner}/{project}

🚧
PATCH
If your client does not support PATCH requests, you can use POST to send this request, along with the query parameter _method=PATCH:
i.e. https://api.sbgenomics.com/v2/projects/{project_owner}/{project}?_method=PATCH

👍
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.

Path Params

project_owner

string

required

If you are using Enterprise, use the name of the Division that owns the project; otherwise, enter the project owner's Platform username.

project

string

required

The short name of the project you are editing.

Query Params

fields

array of strings

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

fields

Body Params

name

string

The name of the project you are creating.

description

string

Description of the project.

billing_group

string

The ID of the billing group for the project. List all billing groups to find your billing group ID

settings

object

Contains detailed project settings. Expand for more details.

Path for Seven Bridges Platform EU

PATCH

Referring to your project

200200