Skip to content

You are viewing documentation for Immuta version 2021.3.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Connection Strings API

Audience: All Immuta Users

Content Summary: This page describes the connectionStrings endpoint.

Note

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Search Connection Strings

Endpoint

Method Path Purpose
GET /connectionStrings Search across all connection strings in the handler table.

Query Parameters

Attribute Description Required
SearchText string A string used to filter returned connection strings. The query is executed with a wildcard prefix and suffix. No

Response Parameters

Attribute Description
Values array Details regarding connection strings, including name and count.

Request Example

The following request searches across all connection strings in the handler table.

curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://your-immuta-url.com/connectionStrings

Response Example

{
  "values": [
    {
      "name": "TEST@immuta.us-east-1.testcomputing.com:???/TEST",
      "count": 5
    }
  ]
}