List connections

Use this endpoint to list all database connections configured for your organization. You can apply filters, pagination, and sorting to narrow down results and find specific connections based on your criteria.

GET /v1/management/connections

List connections

cURL

curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/management/connections

200

Example

{
  "page": 1,
  "limit": 50,
  "total": 3,
  "items": [
    {
      "id": "019996b8-f3d1-7d2b-a192-6e91464d82fc",
      "configName": "Midaz - Banco Transacional",
      "productName": "my-product",
      "type": "POSTGRESQL",
      "host": "postgres.cliente.com.br",
      "port": 5432,
      "databaseName": "transaction",
      "userName": "user_midaz_read",
      "schema": "public",
      "ssl": {
        "mode": "require"
      },
      "metadata": {},
      "createdAt": "2025-09-25T10:30:00Z",
      "updatedAt": "2025-09-25T10:30:00Z"
    },
    {
      "id": "019996b9-174d-7a23-9f87-f7336d5ad98c",
      "configName": "Midaz - Metadados de Transacao",
      "productName": "my-product",
      "type": "MONGODB",
      "host": "mongo.cliente.com.br",
      "port": 27017,
      "databaseName": "transaction",
      "userName": "user_midaz_meta",
      "ssl": {
        "mode": "disable"
      },
      "metadata": {},
      "createdAt": "2025-09-25T10:32:00Z",
      "updatedAt": "2025-09-25T10:32:00Z"
    },
    {
      "id": "019996b9-3b1e-7475-bb50-c81bbb553432",
      "configName": "Midaz - Metadados de Onboarding",
      "productName": "my-product",
      "type": "MONGODB",
      "host": "mongo.cliente.com.br",
      "port": 27017,
      "databaseName": "onboarding",
      "userName": "user_onboarding_meta",
      "ssl": {
        "mode": "disable"
      },
      "metadata": {},
      "createdAt": "2025-09-24T18:00:00Z",
      "updatedAt": "2025-09-24T18:00:00Z"
    }
  ]
}

Encabezados

Authorization · string

The authorization token in the Bearer <token> format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

Ejemplo:

"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

X-Product-Name · string

Filter connections by product name. When provided, only connections associated with this product are returned. Must contain only alphanumeric characters, underscores, and hyphens (max 100 characters). The value is normalized to lowercase.

Maximum string length: 100

Pattern: ^[a-zA-Z0-9_-]+$

Ejemplo:

"my-product"

Parámetros de consulta

page · integer · predeterminado: 1

The page number to retrieve (1-indexed).

Rango requerido: x >= 1

Ejemplo:

1

limit · integer · predeterminado: 10

Número máximo de elementos devueltos por página (máximo 1000). Su valor predeterminado es 10 cuando se omite.

Rango requerido: 1 <= x <= 1000

Ejemplo:

10

sortOrder · enum<string> · predeterminado: desc

The order used to sort the results.

Opciones disponibles: asc, desc

Ejemplo:

"desc"

type · enum<string>

Filter connections by database type.

Opciones disponibles: ORACLE, SQL_SERVER, POSTGRESQL, MONGODB, MYSQL

startDate · string<date>

Filter connections created on or after this date (format YYYY-MM-DD).

Ejemplo:

"2025-01-01"

endDate · string<date>

Filter connections created on or before this date (format YYYY-MM-DD).

Ejemplo:

"2025-12-31"

Respuesta

200

application/json

The list of all connections available for the organization.

Paginated list of connections.

page · integer · requerido

Current page number in the paginated results (1-indexed).

Ejemplo:

1

limit · integer · requerido

Maximum number of items returned per page.

Ejemplo:

50

total · integer · requerido

Total count of items available across all pages.

Ejemplo:

3

items · object[] · requerido

Array containing the connections for the current page.

Maximum array length: 100

Show child attributes