Create connection

curl --request POST \
  --url https://api.example.com/v1/management/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Product-Name: <x-product-name>' \
  --data '
{
  "configName": "<string>",
  "databaseName": "<string>",
  "host": "<string>",
  "password": "<string>",
  "port": 123,
  "type": "<string>",
  "userName": "<string>",
  "metadata": {},
  "schema": "<string>"
}
'

import requests

url = "https://api.example.com/v1/management/connections"

payload = {
    "configName": "<string>",
    "databaseName": "<string>",
    "host": "<string>",
    "password": "<string>",
    "port": 123,
    "type": "<string>",
    "userName": "<string>",
    "metadata": {},
    "schema": "<string>"
}
headers = {
    "X-Product-Name": "<x-product-name>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Product-Name': '<x-product-name>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    configName: '<string>',
    databaseName: '<string>',
    host: '<string>',
    password: '<string>',
    port: 123,
    type: '<string>',
    userName: '<string>',
    metadata: {},
    schema: '<string>'
  })
};

fetch('https://api.example.com/v1/management/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/management/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'configName' => '<string>',
    'databaseName' => '<string>',
    'host' => '<string>',
    'password' => '<string>',
    'port' => 123,
    'type' => '<string>',
    'userName' => '<string>',
    'metadata' => [
        
    ],
    'schema' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Product-Name: <x-product-name>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/management/connections"

	payload := strings.NewReader("{\n  \"configName\": \"<string>\",\n  \"databaseName\": \"<string>\",\n  \"host\": \"<string>\",\n  \"password\": \"<string>\",\n  \"port\": 123,\n  \"type\": \"<string>\",\n  \"userName\": \"<string>\",\n  \"metadata\": {},\n  \"schema\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Product-Name", "<x-product-name>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/management/connections")
  .header("X-Product-Name", "<x-product-name>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"configName\": \"<string>\",\n  \"databaseName\": \"<string>\",\n  \"host\": \"<string>\",\n  \"password\": \"<string>\",\n  \"port\": 123,\n  \"type\": \"<string>\",\n  \"userName\": \"<string>\",\n  \"metadata\": {},\n  \"schema\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/management/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Product-Name"] = '<x-product-name>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"configName\": \"<string>\",\n  \"databaseName\": \"<string>\",\n  \"host\": \"<string>\",\n  \"password\": \"<string>\",\n  \"port\": 123,\n  \"type\": \"<string>\",\n  \"userName\": \"<string>\",\n  \"metadata\": {},\n  \"schema\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "configName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "databaseName": "<string>",
  "host": "<string>",
  "id": "<string>",
  "port": 123,
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userName": "<string>",
  "metadata": {},
  "productName": "<string>",
  "schema": "<string>",
  "ssl": {
    "mode": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

management

connections

Create connection

curl --request POST \
  --url https://api.example.com/v1/management/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Product-Name: <x-product-name>' \
  --data '
{
  "configName": "<string>",
  "databaseName": "<string>",
  "host": "<string>",
  "password": "<string>",
  "port": 123,
  "type": "<string>",
  "userName": "<string>",
  "metadata": {},
  "schema": "<string>"
}
'

import requests

url = "https://api.example.com/v1/management/connections"

payload = {
    "configName": "<string>",
    "databaseName": "<string>",
    "host": "<string>",
    "password": "<string>",
    "port": 123,
    "type": "<string>",
    "userName": "<string>",
    "metadata": {},
    "schema": "<string>"
}
headers = {
    "X-Product-Name": "<x-product-name>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Product-Name': '<x-product-name>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    configName: '<string>',
    databaseName: '<string>',
    host: '<string>',
    password: '<string>',
    port: 123,
    type: '<string>',
    userName: '<string>',
    metadata: {},
    schema: '<string>'
  })
};

fetch('https://api.example.com/v1/management/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/management/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'configName' => '<string>',
    'databaseName' => '<string>',
    'host' => '<string>',
    'password' => '<string>',
    'port' => 123,
    'type' => '<string>',
    'userName' => '<string>',
    'metadata' => [
        
    ],
    'schema' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Product-Name: <x-product-name>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/management/connections"

	payload := strings.NewReader("{\n  \"configName\": \"<string>\",\n  \"databaseName\": \"<string>\",\n  \"host\": \"<string>\",\n  \"password\": \"<string>\",\n  \"port\": 123,\n  \"type\": \"<string>\",\n  \"userName\": \"<string>\",\n  \"metadata\": {},\n  \"schema\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Product-Name", "<x-product-name>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/management/connections")
  .header("X-Product-Name", "<x-product-name>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"configName\": \"<string>\",\n  \"databaseName\": \"<string>\",\n  \"host\": \"<string>\",\n  \"password\": \"<string>\",\n  \"port\": 123,\n  \"type\": \"<string>\",\n  \"userName\": \"<string>\",\n  \"metadata\": {},\n  \"schema\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/management/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Product-Name"] = '<x-product-name>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"configName\": \"<string>\",\n  \"databaseName\": \"<string>\",\n  \"host\": \"<string>\",\n  \"password\": \"<string>\",\n  \"port\": 123,\n  \"type\": \"<string>\",\n  \"userName\": \"<string>\",\n  \"metadata\": {},\n  \"schema\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "configName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "databaseName": "<string>",
  "host": "<string>",
  "id": "<string>",
  "port": 123,
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userName": "<string>",
  "metadata": {},
  "productName": "<string>",
  "schema": "<string>",
  "ssl": {
    "mode": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Product-Name

string

required

Product name used for connection isolation.

Example:

"midaz"

Body

application/json

Connection settings and credentials.

configName

string

required

Unique configuration name used to reference this connection.

Example:

"production-db"

databaseName

string

required

Database name to connect to.

Example:

"mydatabase"

host

string

required

Database server hostname or IP address.

Example:

"db.example.com"

password

string

required

Database authentication password.

Example:

"secretpassword"

port

integer<int64>

required

Database server TCP port.

Example:

5432

type

string

required

Database engine type.

Example:

"POSTGRESQL"

userName

string

required

Database authentication username.

Example:

"dbuser"

metadata

object

Optional application-defined connection metadata.

Show child attributes

Example:

{
  "environment": "production",
  "region": "us-east-1"
}

schema

string

Optional default database schema.

Example:

"public"

ssl

object

Optional SSL/TLS connection settings.

Show child attributes

Example:

{
  "ca": "certificate-authority",
  "mode": "require"
}

Response

Created

configName

string

required

Configuration name used to reference the connection.

Example:

"production-db"

createdAt

string<date-time>

required

Timestamp when the connection was created.

Example:

"2026-01-15T10:30:00Z"

databaseName

string

required

Connected database name.

Example:

"mydatabase"

host

string

required

Database server hostname or IP address.

Example:

"db.example.com"

string

required

Unique connection identifier.

Example:

"018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d"

port

integer<int64>

required

Database server TCP port.

Example:

5432

type

string

required

Database engine type.

Example:

"POSTGRESQL"

updatedAt

string<date-time>

required

Timestamp when the connection was last updated.

Example:

"2026-01-16T14:45:00Z"

userName

string

required

Database authentication username.

Example:

"dbuser"

metadata

object

Application-defined connection metadata.

Show child attributes

Example:

{
  "environment": "production",
  "region": "us-east-1"
}

productName

string

Product that owns the connection.

Example:

"midaz"

schema

string

Default database schema, when configured.

Example:

"public"

ssl

object

Configured SSL/TLS settings with secrets omitted.

Show child attributes

Example:

{ "mode": "require" }

⌘I

Connections

Migration

Extraction jobs

Create connection

Authorizations

Headers

Body

Response