Crear una conexión
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": "production-db",
"databaseName": "mydatabase",
"host": "db.example.com",
"password": "secretpassword",
"port": 5432,
"type": "POSTGRESQL",
"userName": "dbuser",
"metadata": {
"environment": "production",
"region": "us-east-1"
},
"schema": "public",
"ssl": {
"ca": "certificate-authority",
"mode": "require"
}
}
'import requests
url = "https://api.example.com/v1/management/connections"
payload = {
"configName": "production-db",
"databaseName": "mydatabase",
"host": "db.example.com",
"password": "secretpassword",
"port": 5432,
"type": "POSTGRESQL",
"userName": "dbuser",
"metadata": {
"environment": "production",
"region": "us-east-1"
},
"schema": "public",
"ssl": {
"ca": "certificate-authority",
"mode": "require"
}
}
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: 'production-db',
databaseName: 'mydatabase',
host: 'db.example.com',
password: 'secretpassword',
port: 5432,
type: 'POSTGRESQL',
userName: 'dbuser',
metadata: {environment: 'production', region: 'us-east-1'},
schema: 'public',
ssl: {ca: 'certificate-authority', mode: 'require'}
})
};
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' => 'production-db',
'databaseName' => 'mydatabase',
'host' => 'db.example.com',
'password' => 'secretpassword',
'port' => 5432,
'type' => 'POSTGRESQL',
'userName' => 'dbuser',
'metadata' => [
'environment' => 'production',
'region' => 'us-east-1'
],
'schema' => 'public',
'ssl' => [
'ca' => 'certificate-authority',
'mode' => 'require'
]
]),
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\": \"production-db\",\n \"databaseName\": \"mydatabase\",\n \"host\": \"db.example.com\",\n \"password\": \"secretpassword\",\n \"port\": 5432,\n \"type\": \"POSTGRESQL\",\n \"userName\": \"dbuser\",\n \"metadata\": {\n \"environment\": \"production\",\n \"region\": \"us-east-1\"\n },\n \"schema\": \"public\",\n \"ssl\": {\n \"ca\": \"certificate-authority\",\n \"mode\": \"require\"\n }\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\": \"production-db\",\n \"databaseName\": \"mydatabase\",\n \"host\": \"db.example.com\",\n \"password\": \"secretpassword\",\n \"port\": 5432,\n \"type\": \"POSTGRESQL\",\n \"userName\": \"dbuser\",\n \"metadata\": {\n \"environment\": \"production\",\n \"region\": \"us-east-1\"\n },\n \"schema\": \"public\",\n \"ssl\": {\n \"ca\": \"certificate-authority\",\n \"mode\": \"require\"\n }\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\": \"production-db\",\n \"databaseName\": \"mydatabase\",\n \"host\": \"db.example.com\",\n \"password\": \"secretpassword\",\n \"port\": 5432,\n \"type\": \"POSTGRESQL\",\n \"userName\": \"dbuser\",\n \"metadata\": {\n \"environment\": \"production\",\n \"region\": \"us-east-1\"\n },\n \"schema\": \"public\",\n \"ssl\": {\n \"ca\": \"certificate-authority\",\n \"mode\": \"require\"\n }\n}"
response = http.request(request)
puts response.read_body{
"configName": "production-db",
"createdAt": "2026-01-15T10:30:00Z",
"databaseName": "mydatabase",
"host": "db.example.com",
"id": "018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d",
"port": 5432,
"type": "POSTGRESQL",
"updatedAt": "2026-01-16T14:45:00Z",
"userName": "dbuser",
"metadata": {
"environment": "production",
"region": "us-east-1"
},
"productName": "midaz",
"schema": "public",
"ssl": {
"mode": "require"
}
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}Crear una conexión
Crea una conexión de base de datos para el producto indicado en el encabezado X-Product-Name.
POST
/
v1
/
management
/
connections
Crear una conexión
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": "production-db",
"databaseName": "mydatabase",
"host": "db.example.com",
"password": "secretpassword",
"port": 5432,
"type": "POSTGRESQL",
"userName": "dbuser",
"metadata": {
"environment": "production",
"region": "us-east-1"
},
"schema": "public",
"ssl": {
"ca": "certificate-authority",
"mode": "require"
}
}
'import requests
url = "https://api.example.com/v1/management/connections"
payload = {
"configName": "production-db",
"databaseName": "mydatabase",
"host": "db.example.com",
"password": "secretpassword",
"port": 5432,
"type": "POSTGRESQL",
"userName": "dbuser",
"metadata": {
"environment": "production",
"region": "us-east-1"
},
"schema": "public",
"ssl": {
"ca": "certificate-authority",
"mode": "require"
}
}
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: 'production-db',
databaseName: 'mydatabase',
host: 'db.example.com',
password: 'secretpassword',
port: 5432,
type: 'POSTGRESQL',
userName: 'dbuser',
metadata: {environment: 'production', region: 'us-east-1'},
schema: 'public',
ssl: {ca: 'certificate-authority', mode: 'require'}
})
};
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' => 'production-db',
'databaseName' => 'mydatabase',
'host' => 'db.example.com',
'password' => 'secretpassword',
'port' => 5432,
'type' => 'POSTGRESQL',
'userName' => 'dbuser',
'metadata' => [
'environment' => 'production',
'region' => 'us-east-1'
],
'schema' => 'public',
'ssl' => [
'ca' => 'certificate-authority',
'mode' => 'require'
]
]),
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\": \"production-db\",\n \"databaseName\": \"mydatabase\",\n \"host\": \"db.example.com\",\n \"password\": \"secretpassword\",\n \"port\": 5432,\n \"type\": \"POSTGRESQL\",\n \"userName\": \"dbuser\",\n \"metadata\": {\n \"environment\": \"production\",\n \"region\": \"us-east-1\"\n },\n \"schema\": \"public\",\n \"ssl\": {\n \"ca\": \"certificate-authority\",\n \"mode\": \"require\"\n }\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\": \"production-db\",\n \"databaseName\": \"mydatabase\",\n \"host\": \"db.example.com\",\n \"password\": \"secretpassword\",\n \"port\": 5432,\n \"type\": \"POSTGRESQL\",\n \"userName\": \"dbuser\",\n \"metadata\": {\n \"environment\": \"production\",\n \"region\": \"us-east-1\"\n },\n \"schema\": \"public\",\n \"ssl\": {\n \"ca\": \"certificate-authority\",\n \"mode\": \"require\"\n }\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\": \"production-db\",\n \"databaseName\": \"mydatabase\",\n \"host\": \"db.example.com\",\n \"password\": \"secretpassword\",\n \"port\": 5432,\n \"type\": \"POSTGRESQL\",\n \"userName\": \"dbuser\",\n \"metadata\": {\n \"environment\": \"production\",\n \"region\": \"us-east-1\"\n },\n \"schema\": \"public\",\n \"ssl\": {\n \"ca\": \"certificate-authority\",\n \"mode\": \"require\"\n }\n}"
response = http.request(request)
puts response.read_body{
"configName": "production-db",
"createdAt": "2026-01-15T10:30:00Z",
"databaseName": "mydatabase",
"host": "db.example.com",
"id": "018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d",
"port": 5432,
"type": "POSTGRESQL",
"updatedAt": "2026-01-16T14:45:00Z",
"userName": "dbuser",
"metadata": {
"environment": "production",
"region": "us-east-1"
},
"productName": "midaz",
"schema": "public",
"ssl": {
"mode": "require"
}
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}{
"code": "ERR-0001",
"detail": "La propiedad foo es obligatoria, pero no está presente.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Solicitud incorrecta",
"type": "https://example.com/errors/example"
}Autorizaciones
Token JWT de tipo bearer emitido por el proveedor de identidad.
Encabezados
Nombre del producto que se usa para aislar las conexiones.
Ejemplo:
"midaz"
Cuerpo
application/json
Configuración y credenciales de la conexión.
Nombre único de configuración que se usa para hacer referencia a esta conexión.
Ejemplo:
"production-db"
Nombre de la base de datos a la que se establece la conexión.
Ejemplo:
"mydatabase"
Nombre de host o dirección IP del servidor de base de datos.
Ejemplo:
"db.example.com"
Contraseña de autenticación de la base de datos.
Ejemplo:
"secretpassword"
Puerto TCP del servidor de base de datos.
Ejemplo:
5432
Tipo de motor de base de datos.
Ejemplo:
"POSTGRESQL"
Nombre de usuario para la autenticación en la base de datos.
Ejemplo:
"dbuser"
Metadatos opcionales de la conexión definidos por la aplicación.
Show child attributes
Show child attributes
Ejemplo:
{
"environment": "production",
"region": "us-east-1"
}
Esquema predeterminado opcional de la base de datos.
Ejemplo:
"public"
Configuración SSL/TLS opcional de la conexión.
Show child attributes
Show child attributes
Ejemplo:
{
"ca": "certificate-authority",
"mode": "require"
}
Respuesta
Creado
Nombre de configuración que se usa para hacer referencia a la conexión.
Ejemplo:
"production-db"
Fecha y hora de creación de la conexión.
Ejemplo:
"2026-01-15T10:30:00Z"
Nombre de la base de datos conectada.
Ejemplo:
"mydatabase"
Nombre de host o dirección IP del servidor de base de datos.
Ejemplo:
"db.example.com"
Identificador único de la conexión.
Ejemplo:
"018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d"
Puerto TCP del servidor de base de datos.
Ejemplo:
5432
Tipo de motor de base de datos.
Ejemplo:
"POSTGRESQL"
Fecha y hora de la última actualización de la conexión.
Ejemplo:
"2026-01-16T14:45:00Z"
Nombre de usuario para la autenticación en la base de datos.
Ejemplo:
"dbuser"
Metadatos de la conexión definidos por la aplicación.
Show child attributes
Show child attributes
Ejemplo:
{
"environment": "production",
"region": "us-east-1"
}
Producto propietario de la conexión.
Ejemplo:
"midaz"
Esquema predeterminado de la base de datos, si está configurado.
Ejemplo:
"public"
Configuración SSL/TLS establecida, sin incluir los secretos.
Show child attributes
Show child attributes
Ejemplo:
{ "mode": "require" }
¿Esta página le ayudó?