> ## 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.

# Listar conexões

> Retorna uma lista filtrada e paginada de conexões de banco de dados visíveis para o produto opcional. Filtros dinâmicos de metadados usam parâmetros de consulta como metadata.region=br.



## OpenAPI

````yaml pt/openapi/v3-current/connections.yaml get /v1/management/connections
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian
    url: https://github.com/LerianStudio/fetcher/discussions
  description: Documentação da API do componente Manager do Fetcher
  license:
    identifier: Elastic-2.0
    name: Elastic License 2.0 (Source Available)
  title: API do Manager do Fetcher
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
tags:
  - description: Ciclo de vida de conexões de banco de dados e operações de esquema.
    name: Connections
  - description: Operações legadas de atribuição de conexões e migração.
    name: Migration
  - description: Operações de criação e consulta de status de jobs de extração de dados.
    name: Fetcher
paths:
  /v1/management/connections:
    get:
      tags:
        - Connections
      summary: Listar conexões
      description: >-
        Retorna uma lista filtrada e paginada de conexões de banco de dados
        visíveis para o produto opcional. Filtros dinâmicos de metadados usam
        parâmetros de consulta como metadata.region=br.
      operationId: list-connections
      parameters:
        - description: Nome do produto usado para isolar a conexão.
          in: header
          name: X-Product-Name
          schema:
            examples:
              - midaz
            type: string
        - description: Número da página; o padrão é 1.
          in: query
          name: page
          schema:
            default: 1
            examples:
              - 1
            type: integer
        - description: Tamanho da página; o padrão é 10 e o limite é 100.
          in: query
          name: limit
          schema:
            default: 10
            examples:
              - 10
            type: integer
        - description: Direção da ordenação.
          in: query
          name: sortOrder
          schema:
            default: desc
            enum:
              - asc
              - desc
            examples:
              - desc
            type: string
        - description: Filtro por tipo de banco de dados.
          in: query
          name: type
          schema:
            enum:
              - ORACLE
              - SQL_SERVER
              - POSTGRESQL
              - MONGODB
              - MYSQL
            examples:
              - POSTGRESQL
            type: string
        - description: Data inicial de criação, inclusiva, no formato YYYY-MM-DD.
          in: query
          name: startDate
          schema:
            examples:
              - '2026-01-01'
            type: string
        - description: Data final de criação, inclusiva, no formato YYYY-MM-DD.
          in: query
          name: endDate
          schema:
            examples:
              - '2026-01-31'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionPage'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Solicitação inválida
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Não autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Proibido
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro interno do servidor
components:
  schemas:
    ConnectionPage:
      additionalProperties: false
      properties:
        items:
          description: Conexões retornadas nesta página.
          examples:
            - - configName: production-db
                createdAt: '2026-01-15T10:30:00Z'
                databaseName: mydatabase
                host: db.example.com
                id: 018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d
                metadata:
                  environment: production
                  region: us-east-1
                port: 5432
                productName: midaz
                schema: public
                ssl:
                  mode: require
                type: POSTGRESQL
                updatedAt: '2026-01-16T14:45:00Z'
                userName: dbuser
          items:
            $ref: '#/components/schemas/ConnectionResponse'
          type:
            - array
            - 'null'
        limit:
          description: Número máximo de itens retornados por página.
          examples:
            - 10
          format: int64
          type: integer
        page:
          description: Número da página atual.
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Total de conexões correspondentes.
          examples:
            - 10
          format: int64
          type: integer
      required:
        - items
        - limit
        - total
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, restrito ao
            serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicação legível específica desta ocorrência do problema.
          examples:
            - A propriedade foo é obrigatória, mas está ausente.
          type: string
        errors:
          description: Lista opcional de detalhes individuais do erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: Referência URI que identifica a ocorrência específica do problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumo curto e legível do tipo de problema. Esse valor não deve
            mudar entre ocorrências do erro.
          examples:
            - Requisição inválida
          type: string
        type:
          default: about:blank
          description: Referência URI para a documentação legível do erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ConnectionResponse:
      additionalProperties: false
      properties:
        configName:
          description: Nome de configuração usado para referenciar a conexão.
          examples:
            - production-db
          type: string
        createdAt:
          description: Data e hora em que a conexão foi criada.
          examples:
            - '2026-01-15T10:30:00Z'
          format: date-time
          type: string
        databaseName:
          description: Nome do banco de dados conectado.
          examples:
            - mydatabase
          type: string
        host:
          description: Nome do host ou endereço IP do servidor de banco de dados.
          examples:
            - db.example.com
          type: string
        id:
          description: Identificador exclusivo da conexão.
          examples:
            - 018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d
          type: string
        metadata:
          additionalProperties: {}
          description: Metadados da conexão definidos pela aplicação.
          examples:
            - environment: production
              region: us-east-1
          type: object
        port:
          description: Porta TCP do servidor de banco de dados.
          examples:
            - 5432
          format: int64
          type: integer
        productName:
          description: Produto proprietário da conexão.
          examples:
            - midaz
          type: string
        schema:
          description: Esquema padrão do banco de dados, quando configurado.
          examples:
            - public
          type: string
        ssl:
          $ref: '#/components/schemas/SSLResponse'
          description: Configurações de SSL/TLS definidas, sem os dados sigilosos.
          examples:
            - mode: require
        type:
          description: Tipo do mecanismo de banco de dados.
          examples:
            - POSTGRESQL
          type: string
        updatedAt:
          description: Data e hora da última atualização da conexão.
          examples:
            - '2026-01-16T14:45:00Z'
          format: date-time
          type: string
        userName:
          description: Nome de usuário para autenticação no banco de dados.
          examples:
            - dbuser
          type: string
      required:
        - id
        - configName
        - type
        - host
        - port
        - databaseName
        - userName
        - createdAt
        - updatedAt
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Local em que o erro ocorreu, por exemplo, 'body.items[3].tags' ou
            'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: Valor no local indicado
      type: object
    SSLResponse:
      additionalProperties: false
      properties:
        mode:
          description: Modo SSL/TLS específico do driver configurado.
          examples:
            - require
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: Token JWT do tipo bearer emitido pelo provedor de identidade.
      scheme: bearer
      type: http

````