Seven Bridges knowledge centerDocumentation
API Reference

Create a new project

post https://cavatica-api.sbgenomics.com/v2

/projects

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

This call creates a new project.

https://cavatica-api.sbgenomics.com/v2/projects

Request

Example request

POST /v2/projects HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
content-type: application/json

curl --data '{"name": "My New Project", "description": "A project for testing my apps", "billing_group": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7a"}' -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X POST "https://cavatica-api.sbgenomics.com/v2/projects"

Header Fields

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

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

Request body

In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table.

KeyDatatype of valueDescription of value
project
required		stringThe name of the project you are creating.
billing_group
required		stringThe ID of the billing group for the project.

List all billing groups to find your billing group ID
use_memoizationbooleanSet to false by default. Set to true to enable memoization.
intermediate_filesdictionarySpecifies intermediate files retention period.

To do this, specify a dictionary with the following format:
{ "retention": "LIMITED", "duration": 24 }
The minimum value is 1 h. The maximum value is 120 h and the default value is 24 h.
descriptionstringA description of the project.
typestringIf you are running the Platform on AWS, and you want to create an 'old-style' non-developer project, then set this to v1.
settingsdictionaryThis dictionary contains two fields, locked and use_interruptible_instances - see below for further information.
lockedBooleanThis 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_instancesBooleanThis field can be true or false. If not included in the request, spot instances are enabled by default.
allow_network_accessBooleanAllows you to control network access for executions within the project.

👍

Project short names

Recall from the API Overview that projects are assigned short names. When you specify the given name of your project, in the request body, the short name will be automatically generated, using the process described in the API Overview.

Example request body

{
	"name": "My New Project", 
  "description": "A project for testing my apps", 
  "billing_group": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7a"
}

Response

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

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-new-project",
  "id": "RFranklin/my-new-project",
  "name": "My New Project",
  "type": "v2",
  "tags": [],
  "description": "A project for testing my apps",
  "settings": {
    "locked": true,
    "use_interruptible_instances": false,
    "allow_network_access": true,
    "use_memoization": true,
    "intermediate_files": {
      "retention":"LIMITED",
      "duration":24
     }
  },
  "billing_group": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7a"
}

🚧

Interpreting the response body

The response will include an empty list [] for the object tags. This is a legacy feature of the API, and should be ignored.

Language