> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Atribuir uma conexão a um produto

> Use este endpoint para atribuir a um produto uma conexão que ainda não tem um. Informe o produto de destino por meio do cabeçalho `X-Product-Name`. Esta é uma operação única e irreversível: depois que uma conexão é atribuída a um produto, ela não pode ser reatribuída. Use o endpoint [Listar conexões não atribuídas](/pt/reference/reporter/connections/list-unassigned-connections) para encontrar as conexões que ainda precisam de um produto.



## OpenAPI

````yaml pt/openapi/v3-current/connections.yaml post /v1/management/connections/{id}/assign
openapi: 3.1.0
info:
  title: Conexões de Banco de Dados
  description: >-
    A API de conexões de banco de dados fornece endpoints para gerenciar as
    conexões de banco de dados usadas pelo Reporter. Ela permite criar, listar,
    atualizar, excluir e testar conexões de banco de dados, além de validar
    esquemas em relação às fontes de dados configuradas.
  version: 1.0.0
servers:
  - url: https://reporter.sandbox.lerian.net
security: []
tags:
  - name: Database Connections
    description: >-
      Endpoints para gerenciar as conexões de banco de dados usadas pelo
      Reporter.
paths:
  /v1/management/connections/{id}/assign:
    post:
      tags:
        - Database Connections
      summary: Atribuir uma conexão a um produto
      description: >-
        Use este endpoint para atribuir a um produto uma conexão que ainda não
        tem um. Informe o produto de destino por meio do cabeçalho
        `X-Product-Name`. Esta é uma operação única e irreversível: depois que
        uma conexão é atribuída a um produto, ela não pode ser reatribuída. Use
        o endpoint [Listar conexões não
        atribuídas](/pt/reference/reporter/connections/list-unassigned-connections)
        para encontrar as conexões que ainda precisam de um produto.
      parameters:
        - $ref: '#/components/parameters/ConnectionId'
        - $ref: '#/components/parameters/Authorization'
        - name: X-Product-Name
          in: header
          description: >-
            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.
          required: true
          schema:
            type: string
            maxLength: 100
            pattern: ^[a-zA-Z0-9_-]+$
            example: my-product
      responses:
        '200':
          description: A conexão depois de ter sido atribuída ao produto.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResponse'
              example:
                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'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error0402:
                  $ref: '#/components/examples/Error0402'
                Error0404:
                  $ref: '#/components/examples/Error0404'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error1001:
                  $ref: '#/components/examples/Error1001'
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error1015:
                  $ref: '#/components/examples/Error1015'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error0002:
                  $ref: '#/components/examples/Error0002'
      security: []
components:
  parameters:
    ConnectionId:
      name: id
      in: path
      description: Identificador único da conexão (formato UUID).
      required: true
      schema:
        type: string
        format: uuid
        example: 019996b8-f3d1-7d2b-a192-6e91464d82fc
    Authorization:
      name: Authorization
      in: header
      description: >-
        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](/pt/platform/access-manager/access-manager).
      required: false
      schema:
        type: string
        example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
  schemas:
    ConnectionResponse:
      type: object
      description: Objeto de resposta contendo os detalhes da conexão.
      required:
        - id
        - configName
        - type
        - host
        - port
        - databaseName
        - userName
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único da conexão (formato UUID).
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        productName:
          type: string
          description: >-
            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.
          example: my-product
        configName:
          type: string
          description: Nome identificador único desta configuração de conexão.
          example: production-db
        type:
          type: string
          description: >-
            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](/pt/reference/reporter/list-data-sources) retorna
            identificadores em minúsculas (`postgresql`, `mongodb`).
          enum:
            - ORACLE
            - SQL_SERVER
            - POSTGRESQL
            - MONGODB
            - MYSQL
          example: POSTGRESQL
        host:
          type: string
          description: Nome de host ou endereço IP do servidor de banco de dados.
          example: db.example.com
        port:
          type: integer
          description: Número da porta de rede para a conexão de banco de dados.
          example: 5432
        databaseName:
          type: string
          description: Nome do banco de dados ao qual se conectar no servidor de destino.
          example: mydatabase
        userName:
          type: string
          description: Credencial de nome de usuário para autenticação no banco de dados.
          example: dbuser
        schema:
          type: string
          description: Nome do esquema do banco de dados, quando definido.
          example: public
        ssl:
          $ref: '#/components/schemas/SSLResponse'
        metadata:
          $ref: '#/components/schemas/Metadata'
        createdAt:
          type: string
          format: date-time
          description: Carimbo de data/hora ISO 8601 indicando quando a conexão foi criada.
          example: '2024-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: >-
            Carimbo de data/hora ISO 8601 indicando quando a conexão foi
            atualizada pela última vez.
          example: '2024-01-15T10:30:00Z'
    Error:
      type: object
      description: >-
        Mensagem de erro da resposta. Os códigos de erro usam o prefixo `FET`
        para identificar problemas relacionados à API de conexões de banco de
        dados.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro (com o prefixo `FET`).
          example: FET-0001
        title:
          type: string
          description: Um breve resumo do problema.
          example: Missing required fields
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
          example: >-
            One or more required fields are missing. Please ensure all required
            fields like configName, host, port, userName, and password are
            included.
    SSLResponse:
      type: object
      description: >-
        Configuração SSL retornada nas respostas de conexão. Apenas o `mode` SSL
        é exposto; o material de certificado (`ca`, `cert`, `key`) nunca é
        retornado.
      properties:
        mode:
          type: string
          description: Modo de conexão SSL configurado para esta conexão.
          enum:
            - disable
            - require
            - verify-ca
            - verify-full
          example: require
    Metadata:
      type: object
      additionalProperties:
        type: string
        maxLength: 2000
      description: >-
        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.
      example:
        environment: production
        team: data-engineering
  examples:
    Error0402:
      summary: Missing Fields in Request
      value:
        code: FET-0402
        title: Missing Fields in Request
        message: >-
          Your request is missing one or more required fields. Please refer to
          the documentation to ensure all necessary fields are included in your
          request.
    Error0404:
      summary: Invalid Path Parameter
      value:
        code: FET-0404
        title: Invalid Path Parameter
        message: >-
          Path parameters is in an incorrect format. Please check the following
          parameter 'id' and ensure they meet the required format before trying
          again.
    Error1001:
      summary: Entity Not Found
      value:
        code: FET-1001
        title: Entity Not Found
        message: >-
          It was not possible to find the connection entity during the requested
          flow. Please review the data provided in the request.
    Error1015:
      summary: Connection Already Assigned
      value:
        code: FET-1015
        title: Connection Already Assigned
        message: >-
          The connection is already assigned to a product and cannot be
          reassigned.
    Error0002:
      summary: Internal Server Error
      value:
        code: FET-0002
        title: Internal Server Error
        message: >-
          The server encountered an unexpected error. Please try again later or
          contact support.

````