Create connection

POST/v1/connectionsCreate connection

Creates a new connection for the specified database.

Request body

application/json

object

databaseIdstringrequired

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

namestringrequired

maxLength 65 · minLength 3

Example request

{
  "databaseId": "string",
  "name": "string"
}

Responses

object

dataobjectrequired

Show child attributes

connectionStringstringrequired

Deprecated: use `endpoints.direct.connectionString` or `endpoints.pooled.connectionString` instead.

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

connectionStringstringrequired

hoststringrequired

portnumberrequired

directobject

Show child attributes

connectionStringstringrequired

hoststringrequired

portnumberrequired

pooledobject

Show child attributes

connectionStringstringrequired

hoststringrequired

portnumberrequired

hostnull | stringrequired

Deprecated: use `endpoints.direct` instead.

idstringrequired

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

kindstringrequired

one of "postgres", "accelerate"

namestringrequired

passnull | stringrequired

Deprecated: use `endpoints.direct.connectionString` or `endpoints.pooled.connectionString` instead.

typestringrequired

const "connection"

urlstring · urirequired

usernull | stringrequired

Deprecated: use `endpoints.direct.connectionString` or `endpoints.pooled.connectionString` instead.

Example response

{
  "data": {
    "connectionString": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "database": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "directConnection": {
      "host": "string",
      "pass": "string",
      "user": "string"
    },
    "endpoints": {
      "accelerate": {
        "connectionString": "string",
        "host": "string",
        "port": 0
      },
      "direct": {
        "connectionString": "string",
        "host": "string",
        "port": 0
      },
      "pooled": {
        "connectionString": "string",
        "host": "string",
        "port": 0
      }
    },
    "host": "string",
    "id": "string",
    "kind": "accelerate",
    "name": "string",
    "pass": "string",
    "type": "connection",
    "url": "https://example.com",
    "user": "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

curl -X POST 'https://api.prisma.io/v1/connections' \
  -H 'Content-Type: application/json' \
  -d '{"databaseId":"string","name":"string"}'

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

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

import requests

response = requests.request(
    "POST",
    "https://api.prisma.io/v1/connections",
    headers={"Content-Type": "application/json"},
    data='{"databaseId":"string","name":"string"}',
)
print(response.json())

package main

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

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

require 'net/http'

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

{
  "data": {
    "connectionString": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "database": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "directConnection": {
      "host": "string",
      "pass": "string",
      "user": "string"
    },
    "endpoints": {
      "accelerate": {
        "connectionString": "string",
        "host": "string",
        "port": 0
      },
      "direct": {
        "connectionString": "string",
        "host": "string",
        "port": 0
      },
      "pooled": {
        "connectionString": "string",
        "host": "string",
        "port": 0
      }
    },
    "host": "string",
    "id": "string",
    "kind": "accelerate",
    "name": "string",
    "pass": "string",
    "type": "connection",
    "url": "https://example.com",
    "user": "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

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets