Skip to main content
Create a new project
curl --request POST \
  --url https://sapi.withsutro.com/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-sutro-api-client: <api-key>' \
  --data '
{
  "name": "<string>",
  "components": [
    "backend"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "components": []
}

Authorizations

​
Authorization
string
header
required

Builder authentication and authorization

​
x-sutro-api-client
string
header
required

A unique identifier for the API Client making a request

Body

application/json
​
name
string
required

A short name for a Project`

Maximum string length: 128
Example:

"My Cool Project"

​
components
enum<string>[]

Which components this project will generate (frontend, backend, or both). Defaults to backend-only.

Available options:
frontend,
backend
Examples:
["backend"]
["frontend", "backend"]

Response

The newly created Project

​
id
string<uuid>
required

A unique id for your Project

Example:

"b08631ad-a4ec-4c27-9995-01287e83d565"

​
name
string
required

A short name for your Project

Maximum string length: 128
Example:

"My Cool Project"

​
customerId
string<uuid>
required

The customer organization this project belongs to

​
components
enum<string>[]

Which components are configured for this project (frontend, backend, or both)

Available options:
frontend,
backend
Examples:
["backend"]
["frontend", "backend"]