[Experimental]

Acquire Alchemy deploy lease

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Acquires the deploy lease for a (branch, stack, stage). An expired lease is replaced atomically; a live lease fails fast with 409 naming the current holder — there is no queueing. Every Alchemy state operation requires a live deploy lease.

post/v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease

Request

  • Base URL: https://api.prisma.io
  • URL: https://api.prisma.io/v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.prisma.io/authorize, token URL https://auth.prisma.io/token, scopes: workspace:admin, offline_access)
    • HTTP bearer

Path parameters

projectIdstring required
branchIdstring required

Request body

stackstring required

Alchemy stack name (opaque wire value).

stagestring required

Alchemy stage name (opaque wire value).

ttlSecondsinteger

Requested lease TTL in seconds. Default 60, clamped to [30, 300].

holderDescriptionstring

Free-form description of the acquiring deploy, echoed in the contention error so a blocked deploy can name who holds the lease.

Response

Acquired the deploy lease.

Changes

No recorded changes to this operation across all 1 revision of this API.