Get Connection Type | Polytomic Docs

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

{
  "$anchor": "postgresql-connection-schema",
  "$comment": "JSON schema describing the configuration for a PostgreSQL connection type.",
  "$defs": {},
  "$dynamicRef": "#/definitions/postgresqlConfig",
  "$id": "https://app.polytomic.com/schemas/connection_types/postgresql.json",
  "$ref": "#/definitions/postgresqlConfig",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": {
    "deprecated": true,
    "description": "Additional properties for PostgreSQL connection configuration.",
    "maxLength": 255,
    "maxProperties": 10,
    "minLength": 1,
    "minProperties": 1,
    "properties": {
      "host": {
        "description": "Hostname or IP address of the PostgreSQL server.",
        "type": "string",
        "format": "hostname",
        "examples": [
          "db.example.com"
        ]
      },
      "port": {
        "description": "Port number on which the PostgreSQL server is listening.",
        "type": "integer",
        "minimum": 1,
        "maximum": 65535,
        "examples": [
          5432
        ]
      },
      "database": {
        "description": "Name of the PostgreSQL database to connect to.",
        "type": "string",
        "examples": [
          "customer_data"
        ]
      },
      "user": {
        "description": "Username for authenticating to the PostgreSQL server.",
        "type": "string",
        "examples": [
          "dbadmin"
        ]
      },
      "password": {
        "description": "Password for the PostgreSQL user.",
        "type": "string",
        "writeOnly": true,
        "examples": [
          "S3cureP@ssw0rd!"
        ]
      },
      "sslmode": {
        "description": "SSL mode to use for the connection.",
        "type": "string",
        "enum": [
          "disable",
          "allow",
          "prefer",
          "require",
          "verify-ca",
          "verify-full"
        ],
        "default": "prefer",
        "examples": [
          "require"
        ]
      },
      "connect_timeout": {
        "description": "Connection timeout in seconds.",
        "type": "integer",
        "minimum": 1,
        "maximum": 60,
        "default": 10,
        "examples": [
          15
        ]
      }
    },
    "readOnly": true,
    "required": [
      "host",
      "port",
      "database",
      "user",
      "password"
    ],
    "title": "PostgreSQL Connection Configuration",
    "type": "object",
    "uniqueItems": true,
    "writeOnly": true
  },
  "allOf": [
    null
  ],
  "anyOf": [
    null
  ],
  "contentEncoding": "utf-8",
  "contentMediaType": "application/json",
  "dependentRequired": {},
  "dependentSchemas": {},
  "deprecated": false,
  "description": "Schema for PostgreSQL connection type configuration.",
  "enum": [
    null
  ],
  "examples": [
    null
  ],
  "exclusiveMaximum": "false",
  "exclusiveMinimum": "false",
  "format": "json",
  "maxContains": 1,
  "maxItems": 1,
  "maxLength": 10000,
  "maxProperties": 10,
  "maximum": "10000",
  "minContains": 1,
  "minItems": 1,
  "minLength": 1,
  "minProperties": 5,
  "minimum": "1",
  "multipleOf": "1",
  "oneOf": [
    null
  ],
  "pattern": "^[a-zA-Z0-9_\\-]+$",
  "patternProperties": {},
  "prefixItems": [
    null
  ],
  "properties": {},
  "readOnly": true,
  "required": [
    "host",
    "port",
    "database",
    "user",
    "password"
  ],
  "title": "PostgreSQL Connection Type Schema",
  "type": "object",
  "uniqueItems": true,
  "writeOnly": false
}

Returns the JSON schema for a connection type.

This schema is intended for building forms or validating configuration payloads client-side. It describes the structure Polytomic expects when you create or update a connection of the given type.

The response is metadata about the shape of the configuration, not a live connection instance and not a set of current credential values.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequired

Connection type identifier (e.g. postgresql, salesforce, hubspot).

Response

$anchorstring

$commentstring

$defsmap from strings to objects

$dynamicRefstring

$idstring

$refstring

$schemastring

additionalPropertiesobject

allOflist of objects

anyOflist of objects

constany

containsobject

contentEncodingstring

contentMediaTypestring

contentSchemaobject

defaultany

dependentRequiredmap from strings to lists of strings

dependentSchemasmap from strings to objects

deprecatedboolean

descriptionstring

elseobject

enumlist of any

exampleslist of any

exclusiveMaximumstring

exclusiveMinimumstring

formatstring

ifobject

itemsobject

maxContainsinteger or null>=0

maxItemsinteger or null>=0

maxLengthinteger or null>=0

maxPropertiesinteger or null>=0

maximumstring

minContainsinteger or null>=0

minItemsinteger or null>=0

minLengthinteger or null>=0

minPropertiesinteger or null>=0

minimumstring

multipleOfstring

notobject

oneOflist of objects

patternstring

patternPropertiesmap from strings to objects

prefixItemslist of objects

propertiesobject

propertyNamesobject

readOnlyboolean

requiredlist of strings

thenobject

titlestring

typestring

uniqueItemsboolean

writeOnlyboolean

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors