Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Body

application/json
gitRepo
string

Source repository as "owner/repo".

Pattern: ^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$
gitRef
string

Branch, tag, or commit. Defaults to main.

environment
string

Environment to deploy to. Defaults to "production". An environment that does not exist on the project answers 404. Preview deployments are created from pull requests, never here.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Response

Deployment accepted.

id
string
required
status
enum<string>
required
Available options:
queued,
building,
deploying,
ready,
failed