OMomni
Connections

List connections

Changed on

Retrieves a list of database connections with optional filtering and sorting

get/v1/connections

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/connections
  • Auth
    HTTP bearer

Query parameters

namestring

Filter connections by name (case-insensitive, partial matching)

databasestring

Filter connections by database name (case-insensitive, partial matching)

dialectstring

Filter connections by dialect(s). For multiple dialects, provide a comma-separated list (e.g., postgres,mysql).

sortField'database' | 'dialect' | 'name'

Field to sort by

sortDirection'asc' | 'desc'

Direction for sorting results:

  • asc - Ascending order (A-Z, 0-9)
  • desc - Descending order (Z-A, 9-0)
includeDeletedboolean

When true, the response includes deleted connections. Defaults to false.

Response

Returns a list of connections objects

Example response

{
  "connections": [
    {
      "id": "c0f12353-4817-4398-bcc0-d501e6dd2f64",
      "name": "Production Database",
      "dialect": "postgres",
      "database": "prod_db",
      "baseRole": "NO_ACCESS",
      "createdAt": "2026-06-01T14:30:00.000Z",
      "updatedAt": "2026-06-11T10:15:30.000Z",
      "userAttributeNameForConnectionEnvironments": "environment",
      "defaultSchema": "public"
    }
  ]
}

Changes

  • 43290040f88fRevision changes
    • breaking

      removed the enum value athena from the query request parameter dialect

    • breaking

      removed the enum value bigquery from the query request parameter dialect

    • breaking

      removed the enum value clickhouse from the query request parameter dialect

    • breaking

      removed the enum value databricks from the query request parameter dialect

    • breaking

      removed the enum value databricks_lakebase from the query request parameter dialect

    • breaking

      removed the enum value exasol from the query request parameter dialect

    • breaking

      removed the enum value mariadb from the query request parameter dialect

    • breaking

      removed the enum value motherduck from the query request parameter dialect

    • breaking

      removed the enum value mssql from the query request parameter dialect

    • breaking

      removed the enum value mysql from the query request parameter dialect

    • breaking

      removed the enum value oracle from the query request parameter dialect

    • breaking

      removed the enum value postgres from the query request parameter dialect

    • breaking

      removed the enum value redshift from the query request parameter dialect

    • breaking

      removed the enum value sap_hana from the query request parameter dialect

    • breaking

      removed the enum value snowflake from the query request parameter dialect

    • breaking

      removed the enum value starrocks from the query request parameter dialect

    • breaking

      removed the enum value trino from the query request parameter dialect

    • breaking

      added the pattern ^(?:\s*(bigquery|mysql|postgres|redshift|exasol|snowflake|motherduck|mssql|fabric|databricks|databricks_lakebase|clickhouse|trino|athena|starrocks|mariadb|oracle|sap_hana)\s*(?:,\s*(bigquery|mysql|postgres|redshift|exasol|snowflake|motherduck|mssql|fabric|databricks|databricks_lakebase|clickhouse|trino|athena|starrocks|mariadb|oracle|sap_hana)\s*)*)?$ to the query request parameter dialect