# Acquire Alchemy deploy lease

**POST** `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/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.

Base URL: `https://api.prisma.io`

Tags: `[Experimental]`

## Authorization

Any ONE of the following options authorizes this operation; every scheme listed within an option is required together.

| Option | Scheme | Type | Sent as | Scopes |
| --- | --- | --- | --- | --- |
| Option 1 | `OAuth2` | `oauth2` | `Authorization: Bearer <access token>` | `offline_access`, `workspace:admin` |
| Option 2 | `Bearer` | `http` | `Authorization: Bearer <token>` (JWT) | — |

### OAuth 2.0 flows

- **OAuth2 · authorizationCode**
  - Authorization URL: `https://auth.prisma.io/authorize`
  - Token URL: `https://auth.prisma.io/token`
  - Refresh URL: `https://auth.prisma.io/token`
  - Scope `offline_access` — Offline access
  - Scope `workspace:admin` — Full access to workspace resources

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | `string` | Yes | — |
| `branchId` | `string` | Yes | — |

## Request body

Optional. Media type: `application/json`

### Example request body

```json
{
  "holderDescription": "string",
  "stack": "string",
  "stage": "string",
  "ttlSeconds": 0
}
```

## Responses

| Status | Description | Media type |
| --- | --- | --- |
| `201` | Acquired the deploy lease. | `application/json` |
| `401` | Missing or invalid authorization token. | `application/json` |
| `404` | Project or branch not found. | `application/json` |
| `409` | The deploy lease is held by another deploy. | `application/json` |
| `413` | Request body exceeds this endpoint's size cap. | `application/json` |

### Example response: 201 — Acquired the deploy lease.

```json
{
  "data": {
    "expiresAt": "string",
    "leaseId": "string"
  }
}
```

### Example response: 401 — Missing or invalid authorization token.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 404 — Project or branch not found.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 409 — The deploy lease is held by another deploy.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

### Example response: 413 — Request body exceeds this endpoint's size cap.

```json
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
```

## Related pages

- [[Experimental]](./tags/experimental.md)
- [Agents](./tags/agents.md)
- [Alchemy state store version](./getv1projectsbyprojectidbranchesbybranchidalchemy-stateversion.md)
- [Buckets](./tags/buckets.md)
- [Connections](./tags/connections.md)
- [Create a branch](./postv1projectsbyprojectidbranches.md)
- [Create a custom domain](./postv1appsbyappiddomains.md)
- [Create a custom domain](./postv1servicesbyserviceiddomains.md)
- [Create a workspace](./postv1workspaces.md)
- [Create an environment variable](./postv1environment-variables.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.
