Get Connection Types | Polytomic Docs

curl https://app.polytomic.com/api/connection_types \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "data": [
    {
      "capabilities": {
        "destination": true,
        "enrichment": false,
        "orchestration": false,
        "source": true
      },
      "configurationForm": {
        "jsonschema": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string",
              "title": "Host",
              "description": "Database server hostname or IP address"
            },
            "port": {
              "type": "integer",
              "title": "Port",
              "default": 5432,
              "minimum": 1,
              "maximum": 65535
            },
            "database": {
              "type": "string",
              "title": "Database Name"
            },
            "username": {
              "type": "string",
              "title": "Username"
            },
            "password": {
              "type": "string",
              "title": "Password"
            },
            "sslmode": {
              "type": "string",
              "title": "SSL Mode",
              "enum": [
                "disable",
                "require",
                "verify-ca",
                "verify-full"
              ],
              "default": "require"
            }
          },
          "required": [
            "host",
            "port",
            "database",
            "username",
            "password"
          ]
        },
        "uischema": {
          "password": {
            "ui:widget": "password"
          },
          "sslmode": {
            "ui:widget": "select"
          }
        }
      },
      "envConfig": {
        "PGHOST": "db.example.com",
        "PGPORT": 5432,
        "PGDATABASE": "analytics",
        "PGUSER": "polytomic_user"
      },
      "id": "postgresql",
      "initialConfiguration": {
        "host": "db.example.com",
        "port": 5432,
        "database": "analytics",
        "username": "polytomic_user",
        "sslmode": "require"
      },
      "logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
      "name": "PostgreSQL",
      "oauth_prompt": {
        "when": "never"
      },
      "use_oauth": false
    }
  ]
}

Lists all connection types supported by this deployment.

Each entry includes per-type metadata:

The available operations the connection type supports.
Its category.
Whether the connection type is enabled for the caller’s organization.
Which modes (source, destination, enrichment) it can act as.

Lists all connection types supported by this deployment. Each entry includes per-type metadata: - The available operations the connection type supports. - Its category. - Whether the connection type is enabled for the caller's organization. - Which modes (source, destination, enrichment) it can act as.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Response

datalist of objects or null

Errors

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Response

Errors