Pular para o conteúdo principal
POST
/
v1
/
management
/
connections
/
{id}
/
assign
Atribuir uma conexão a um produto
curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign \
  --header 'X-Product-Name: <x-product-name>'
import requests

url = "https://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign"

headers = {"X-Product-Name": "<x-product-name>"}

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

print(response.text)
const options = {method: 'POST', headers: {'X-Product-Name': '<x-product-name>'}};

fetch('https://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign', 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://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign"

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

req.Header.Add("X-Product-Name", "<x-product-name>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign")
.header("X-Product-Name", "<x-product-name>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://reporter.sandbox.lerian.net/v1/management/connections/{id}/assign")

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>'

response = http.request(request)
puts response.read_body
{
  "id": "019996b8-f3d1-7d2b-a192-6e91464d82fc",
  "configName": "legacy-transactional-db",
  "productName": "my-product",
  "type": "POSTGRESQL",
  "host": "postgres.cliente.com.br",
  "port": 5432,
  "databaseName": "transaction",
  "userName": "user_legacy_read",
  "schema": "public",
  "ssl": {
    "mode": "require"
  },
  "metadata": {},
  "createdAt": "2025-09-25T10:30:00Z",
  "updatedAt": "2025-09-25T10:35:00Z"
}

Cabeçalhos

Authorization
string

O token de autorização no formato Bearer <token>.

Importante: Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

Exemplo:

"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

X-Product-Name
string
obrigatório

O nome de produto a ser atribuído a esta conexão. Deve conter apenas caracteres alfanuméricos, underscores e hifens (máx. 100 caracteres). O valor é normalizado para minúsculas.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9_-]+$
Exemplo:

"my-product"

Parâmetros de caminho

id
string<uuid>
obrigatório

Identificador único da conexão (formato UUID).

Exemplo:

"019996b8-f3d1-7d2b-a192-6e91464d82fc"

Resposta

A conexão depois de ter sido atribuída ao produto.

Objeto de resposta contendo os detalhes da conexão.

id
string<uuid>
obrigatório

Identificador único da conexão (formato UUID).

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

configName
string
obrigatório

Nome identificador único desta configuração de conexão.

Exemplo:

"production-db"

type
enum<string>
obrigatório

Tipo de motor de banco de dados. Valores suportados: ORACLE, SQL_SERVER, POSTGRESQL, MONGODB, MYSQL. Observe que o campo type da fonte de dados no endpoint Listar Fontes de Dados retorna identificadores em minúsculas (postgresql, mongodb).

Opções disponíveis:
ORACLE,
SQL_SERVER,
POSTGRESQL,
MONGODB,
MYSQL
Exemplo:

"POSTGRESQL"

host
string
obrigatório

Nome de host ou endereço IP do servidor de banco de dados.

Exemplo:

"db.example.com"

port
integer
obrigatório

Número da porta de rede para a conexão de banco de dados.

Exemplo:

5432

databaseName
string
obrigatório

Nome do banco de dados ao qual se conectar no servidor de destino.

Exemplo:

"mydatabase"

userName
string
obrigatório

Credencial de nome de usuário para autenticação no banco de dados.

Exemplo:

"dbuser"

createdAt
string<date-time>
obrigatório

Carimbo de data/hora ISO 8601 indicando quando a conexão foi criada.

Exemplo:

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

productName
string

O nome de produto associado a esta conexão. Pode estar vazio se a conexão não tiver sido atribuída a um produto.

Exemplo:

"my-product"

schema
string

Nome do esquema do banco de dados, quando definido.

Exemplo:

"public"

ssl
object

Configuração SSL retornada nas respostas de conexão. Apenas o mode SSL é exposto; o material de certificado (ca, cert, key) nunca é retornado.

metadata
object

Um objeto contendo pares de chave-valor para armazenar informações adicionais relacionadas à conexão. As chaves (máx. 100 caracteres) e os valores (máx. 2000 caracteres) devem ser strings. Objetos aninhados não são permitidos.

Exemplo:
{
"environment": "production",
"team": "data-engineering"
}
updatedAt
string<date-time>

Carimbo de data/hora ISO 8601 indicando quando a conexão foi atualizada pela última vez.

Exemplo:

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