REST APIDeployments
Deploy the project
Accepts the deployment immediately (202) and builds/uploads asynchronously. Deploys git HEAD by default; pass versionId (a commit SHA from the version history) to deploy a historical version.
Authorization
ApiKey x-api-key<token>
Workspace-owned API key with per-resource permissions.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
versionId?string
Match
^[0-9a-f]{40}$idempotencyKey?string
Length
1 <= length <= 128Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/deployments" \ -H "Content-Type: application/json" \ -d '{}'{ "deploymentId": "a73c85a1-d857-491e-a6b2-51dce05de7a2", "status": "queued"}