Create deployment

Trigger a new deployment for a project. Async — returns a Deployment record with status ‘queued’.

POST /v1/projects/{id}/deployments

Create deployment

cURL

curl --request POST \
  --url https://api.vly.ai/v1/projects/{id}/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment": "preview",
  "branch": "main"
}
'

202

{
  "id": "dpl_01JFA8N3Z1B6Y2K7Q3X4M5R8",
  "project_id": "<string>",
  "environment": "preview",
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Builds and deploys the current state of the project. Defaults to environment: "preview"; pass "production" to promote.

Use Get deployment to poll status, or subscribe to a webhook for deployment.succeeded / deployment.failed.

For continuous deployment, prefer GitHub integration — pushes to main auto-deploy.

Authorizations

Authorization · string · header · required

Workspace-scoped API key. Generate from Workspace settings → API keys.

Path Parameters

id · string · required

Body

application/json

environment · enum<string> · default: preview

Available options: preview, production

branch · string

Example:

"main"

Response

202 - application/json

Accepted

id · string · required

Example:

"dpl_01JFA8N3Z1B6Y2K7Q3X4M5R8"

project_id · string · required

environment · enum<string> · required

Available options: preview, production

status · enum<string> · required

Available options: queued, building, ready, failed

created_at · string<date-time> · required

url · string<uri> | null