Create deployment

/api/v0/deploymentsPOST

Request Bodyapplication/jsonrequired

files *object[]

File paths with SHA-256 content hashes

Show item properties

path *string

Min length: 1Max length: 512

hash *string

Pattern: ^[a-f0-9]+$Min length: 64Max length: 64

projectId?string

Required for session auth; ignored for API key auth

branch?string

Branch name for preview deployments. Defaults to "main".

Max length: 200

preview?boolean

Force preview deployment (e.g. from a PR). Never updates production pointer.

name?string

Site name from docs.json. Updates the project name if provided.

Min length: 1Max length: 200

basePath?string

Base path prefix for subpath deploys (e.g. "/docs/"). Requires Pro subscription.

Pattern: ^\/[a-z0-9\-_/]*\/$Max length: 200

Response

200

deploymentId *string

version *string

existingHashes *string[]

Hashes that already exist in KV — CLI can skip uploading these files

Ask AI about this page

Request example

curl -X POST "https://api.example.com/api/v0/deployments" \
  -H "Content-Type: application/json" \
  -d '{
  "files": [
    {
      "path": "string",
      "hash": "string"
    }
  ],
  "projectId": "string",
  "branch": "string",
  "preview": true,
  "name": "string",
  "basePath": "string"
}'