Heartbeat Alchemy deploy lease

PATCH/v1/projects/{projectId}/branches/{branchId}/alchemy-state/leaseHeartbeat Alchemy deploy lease

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

Extends the unexpired deploy lease addressed by the Alchemy-State-Lease-Id header from now. A missing, replaced, or expired lease returns 404 — the lost-lease signal; an expired lease can never be revived.

Parameters

projectIdstringpathrequired

pattern ^(proj_)?([cC][^\s-]{8,}|[a-z0-9]+)$

branchIdstringpathrequired

pattern ^(br_)?([cC][^\s-]{8,}|[a-z0-9]+)$

alchemy-state-lease-idstringheaderrequired

Deploy-lease id returned by the lease acquire endpoint. Addresses the lease on heartbeat and release, and authorizes every state operation.

pattern ^(aslease_)?([cC][^\s-]{8,}|[a-z0-9]+)$

Request body

application/json

object

ttlSecondsinteger

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

exclusiveMinimum 0

Example request

{
  "ttlSeconds": 0
}

Responses

object

dataobjectrequired

Show child attributes

expiresAtstringrequired

Lease expiry as an ISO-8601 timestamp.

leaseIdstringrequired

Capability token for the deploy lease. Send it in the Alchemy-State-Lease-Id header with every state operation; do not log it.

Example response

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

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

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

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

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

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

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

Examples

projectIdrequiredpath parameter

branchIdrequiredpath parameter

alchemy-state-lease-idrequiredheader parameter

curl -X PATCH 'https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease' \
  -H 'Content-Type: application/json' \
  -d '{"ttlSeconds":0}'

const response = await fetch('https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"ttlSeconds":0}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"ttlSeconds\":0}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease",
    headers={"Content-Type": "application/json"},
    data='{"ttlSeconds":0}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"ttlSeconds":0}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"ttlSeconds\":0}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"ttlSeconds\":0}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"ttlSeconds\":0}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.prisma.io/v1/projects/string/branches/string/alchemy-state/lease");
request.Content = new StringContent("{\"ttlSeconds\":0}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

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

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

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

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

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Parameters

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets