Update database

PATCH/v1/databases/{databaseId}Update database

Updates the database with the given ID. logicalId cannot be combined with branchId or branchGitName in one request; move the database first, then set its logicalId.

Parameters

databaseIdstringpathrequired

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

Request body

application/json

object

branchGitNamenull | string

Git name of the Branch to move the database to; the Branch is created when it does not exist. Mutually exclusive with branchId. Every database belongs to a Branch, so null (detach) is rejected.

minLength 1

branchIdnull | string

ID of the Branch to move the database to. Every database belongs to a Branch, so null (detach) is rejected.

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

logicalIdstring

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource.

maxLength 255 · pattern ^[A-Za-z0-9][A-Za-z0-9._-]*$

namestring

New display name for the database

minLength 1

Example request

{
  "branchGitName": "string",
  "branchId": "string",
  "logicalId": "string",
  "name": "string"
}

Responses

object

dataobjectrequired

Show child attributes

branchIdnull | stringrequired

connectionsarray of objectrequired

Show child attributes

Show array items

createdAtstring · date-timerequired

databaseobjectrequired

Show child attributes

idstringrequired

namestringrequired

urlstring · urirequired

directConnectionnull | object

Deprecated: use `endpoints.direct` instead.

Show child attributes

hoststringrequired

passstringrequired

userstringrequired

endpointsobjectrequired

Show child attributes

accelerateobject

Show child attributes

hoststringrequired

portnumberrequired

directobject

Show child attributes

hoststringrequired

portnumberrequired

pooledobject

Show child attributes

hoststringrequired

portnumberrequired

idstringrequired

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

kindstringrequired

one of "postgres", "accelerate"

namestringrequired

typestringrequired

const "connection"

urlstring · urirequired

createdAtstring · date-timerequired

defaultConnectionIdnull | stringrequired

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

idstringrequired

isDefaultbooleanrequired

logicalIdnull | stringrequired

namestringrequired

projectobjectrequired

Show child attributes

idstringrequired

namestringrequired

urlstring · urirequired

regionnull | objectrequired

Show child attributes

idstringrequired

namestringrequired

sourcevaluerequired

Show child attributes

oneOf · 4 options

Option 1object

typestringrequired

const "empty"

Option 2object

backupIdstringrequired

ID of the backup to restore from

databaseIdstringrequired

typestringrequired

const "backup"

Option 3object

databaseIdstringrequired

typestringrequired

const "database"

Option 4nullnullable

statusstringrequired

one of "failure", "provisioning", "ready", "recovering"

typestringrequired

const "database"

urlstring · urirequired

Example response

{
  "data": {
    "branchId": "string",
    "connections": [
      {
        "createdAt": "2026-06-09T00:00:00Z",
        "database": {
          "id": "string",
          "name": "string",
          "url": "https://example.com"
        },
        "directConnection": {
          "host": "string",
          "pass": "string",
          "user": "string"
        },
        "endpoints": {
          "accelerate": {
            "host": "string",
            "port": 0
          },
          "direct": {
            "host": "string",
            "port": 0
          },
          "pooled": {
            "host": "string",
            "port": 0
          }
        },
        "id": "string",
        "kind": "accelerate",
        "name": "string",
        "type": "connection",
        "url": "https://example.com"
      }
    ],
    "createdAt": "2026-06-09T00:00:00Z",
    "defaultConnectionId": "string",
    "id": "string",
    "isDefault": true,
    "logicalId": "string",
    "name": "string",
    "project": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "region": {
      "id": "string",
      "name": "string"
    },
    "source": {
      "backupId": "string",
      "databaseId": "string",
      "type": "backup"
    },
    "status": "failure",
    "type": "database",
    "url": "https://example.com"
  }
}

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"
  }
}

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

databaseIdrequiredpath parameter

curl -X PATCH 'https://api.prisma.io/v1/databases/string' \
  -H 'Content-Type: application/json' \
  -d '{"branchGitName":"string","branchId":"string","logicalId":"string","name":"string"}'

const response = await fetch('https://api.prisma.io/v1/databases/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"branchGitName":"string","branchId":"string","logicalId":"string","name":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/databases/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.prisma.io/v1/databases/string",
    headers={"Content-Type": "application/json"},
    data='{"branchGitName":"string","branchId":"string","logicalId":"string","name":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"branchGitName":"string","branchId":"string","logicalId":"string","name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.prisma.io/v1/databases/string", 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/databases/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\"}");
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/databases/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/databases/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\"}"
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/databases/string");
request.Content = new StringContent("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "branchId": "string",
    "connections": [
      {
        "createdAt": "2026-06-09T00:00:00Z",
        "database": {
          "id": "string",
          "name": "string",
          "url": "https://example.com"
        },
        "directConnection": {
          "host": "string",
          "pass": "string",
          "user": "string"
        },
        "endpoints": {
          "accelerate": {
            "host": "string",
            "port": 0
          },
          "direct": {
            "host": "string",
            "port": 0
          },
          "pooled": {
            "host": "string",
            "port": 0
          }
        },
        "id": "string",
        "kind": "accelerate",
        "name": "string",
        "type": "connection",
        "url": "https://example.com"
      }
    ],
    "createdAt": "2026-06-09T00:00:00Z",
    "defaultConnectionId": "string",
    "id": "string",
    "isDefault": true,
    "logicalId": "string",
    "name": "string",
    "project": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "region": {
      "id": "string",
      "name": "string"
    },
    "source": {
      "backupId": "string",
      "databaseId": "string",
      "type": "backup"
    },
    "status": "failure",
    "type": "database",
    "url": "https://example.com"
  }
}

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

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "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