Skip to main content
POST
Create a project

Authorizations

x-brimble-key
string
header
required

API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.

Body

application/json
git
enum<string>
required

Git provider, or DOCKER to deploy an image. Case-insensitive.

Available options:
GITHUB,
GITLAB,
BITBUCKET,
DOCKER,
HUGGINGFACE,
ORIGIN
serviceType
enum<string>
required
Available options:
web-service,
static,
mcp,
worker
name
string

Project name. Required when importing a repository (type omitted or import).

Minimum string length: 3
description
string
healthCheckPath
string
buildHealthCheck
boolean
preStartCommand
string
teamId
string

Team to act in. Omit for your personal workspace.

Pattern: ^[a-fA-F0-9]{24}$
environmentId
string
Pattern: ^[a-fA-F0-9]{24}$
repo
object

Required unless template is set.

autoscalingGroup
string | null
buildCommand
string
outputDirectory
string
rootDirectory
string
dockerfile
string
watchPaths
string[]
installCommand
string
runtimeVersions
object
isPrivate
boolean
cronEnabled
boolean
cronExpression
string
cronTimezone
string
cronCommand
string
authEnabled
boolean
default:false
public
boolean
environments
object[]
installationId

Git provider installation id. Required for GitHub when git is GITHUB.

type
enum<string>

Type should either be clone or import

Available options:
import,
clone
clone
object

Required when type is clone.

template
string
configurations
object
registry_credentials
object
diskSize
integer
Required range: 10 <= x <= 150
volumeId
string
Pattern: ^[a-fA-F0-9]{24}$
mountPath
string
deploy
boolean
default:true
startCommand
string | null
framework
string | null

Response

Projects created successfully

message
string
required
Example:

"Projects created successfully"

data
object
required
Last modified on October 10, 2026