Get Connection Type

GET

https://app.polytomic.com/api/connection_types/:id

GET

/api/connection_types/:id

$ curl https://app.polytomic.com/api/connection_types/postgresql \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "$anchor": "postgresql-connection-schema",
3   "$comment": "JSON schema describing the configuration for a PostgreSQL connection type.",
4   "$defs": {},
5   "$dynamicRef": "#/definitions/postgresqlConfig",
6   "$id": "https://app.polytomic.com/schemas/connection_types/postgresql.json",
7   "$ref": "#/definitions/postgresqlConfig",
8   "$schema": "http://json-schema.org/draft-07/schema#",
9   "additionalProperties": {
10     "$anchor": "additionalProperty",
11     "$comment": "Additional properties allowed in the configuration.",
12     "$defs": {},
13     "$dynamicRef": "",
14     "$id": "https://app.polytomic.com/schemas/connection_types/postgresql_additional_property.json",
15     "$ref": "",
16     "$schema": "http://json-schema.org/draft-07/schema#",
17     "allOf": [],
18     "anyOf": [],
19     "contentEncoding": "utf-8",
20     "contentMediaType": "application/json",
21     "dependentRequired": {},
22     "dependentSchemas": {},
23     "deprecated": false,
24     "description": "Any additional property not explicitly defined.",
25     "enum": [],
26     "examples": [],
27     "exclusiveMaximum": null,
28     "exclusiveMinimum": null,
29     "format": "",
30     "maxContains": null,
31     "maxItems": null,
32     "maxLength": 255,
33     "maxProperties": null,
34     "maximum": null,
35     "minContains": null,
36     "minItems": null,
37     "minLength": 1,
38     "minProperties": null,
39     "minimum": null,
40     "multipleOf": null,
41     "oneOf": [],
42     "pattern": "^[a-zA-Z0-9_]+$",
43     "patternProperties": {},
44     "prefixItems": [],
45     "properties": {},
46     "readOnly": false,
47     "required": [],
48     "title": "Additional Property",
49     "type": "string",
50     "uniqueItems": false,
51     "writeOnly": false
52   },
53   "allOf": [
54     {
55       "$anchor": "baseConnection",
56       "$comment": "Base schema for connection configuration.",
57       "$defs": {},
58       "$dynamicRef": "",
59       "$id": "https://app.polytomic.com/schemas/connection_types/base_connection.json",
60       "$ref": "",
61       "$schema": "http://json-schema.org/draft-07/schema#",
62       "allOf": [],
63       "anyOf": [],
64       "contentEncoding": "",
65       "contentMediaType": "",
66       "dependentRequired": {},
67       "dependentSchemas": {},
68       "deprecated": false,
69       "description": "Base connection configuration properties.",
70       "enum": [],
71       "examples": [],
72       "exclusiveMaximum": null,
73       "exclusiveMinimum": null,
74       "format": "",
75       "maxContains": null,
76       "maxItems": null,
77       "maxLength": null,
78       "maxProperties": null,
79       "maximum": null,
80       "minContains": null,
81       "minItems": null,
82       "minLength": null,
83       "minProperties": null,
84       "minimum": null,
85       "multipleOf": null,
86       "oneOf": [],
87       "pattern": "",
88       "patternProperties": {},
89       "prefixItems": [],
90       "properties": {
91         "host": {
92           "type": "string",
93           "description": "Hostname or IP address of the PostgreSQL server.",
94           "examples": [
95             "db.example.com"
96           ]
97         },
98         "port": {
99           "type": "integer",
100           "description": "Port number on which the PostgreSQL server is listening.",
101           "minimum": 1,
102           "maximum": 65535,
103           "examples": [
104             5432
105           ]
106         },
107         "database": {
108           "type": "string",
109           "description": "Name of the PostgreSQL database to connect to.",
110           "examples": [
111             "customer_data"
112           ]
113         },
114         "username": {
115           "type": "string",
116           "description": "Username for authenticating with the PostgreSQL server.",
117           "examples": [
118             "dbuser"
119           ]
120         },
121         "password": {
122           "type": "string",
123           "description": "Password for the PostgreSQL user.",
124           "writeOnly": true,
125           "examples": [
126             "secureP@ssw0rd"
127           ]
128         },
129         "sslmode": {
130           "type": "string",
131           "description": "SSL mode to use for the connection.",
132           "enum": [
133             "disable",
134             "allow",
135             "prefer",
136             "require",
137             "verify-ca",
138             "verify-full"
139           ],
140           "examples": [
141             "require"
142           ]
143         }
144       },
145       "required": [
146         "host",
147         "port",
148         "database",
149         "username",
150         "password"
151       ],
152       "title": "PostgreSQL Connection Configuration",
153       "type": "object",
154       "uniqueItems": false,
155       "writeOnly": false
156     }
157   ],
158   "anyOf": [],
159   "contains": null,
160   "contentEncoding": "",
161   "contentMediaType": "",
162   "contentSchema": null,
163   "dependentRequired": {},
164   "dependentSchemas": {},
165   "deprecated": false,
166   "description": "Schema for PostgreSQL connection type configuration.",
167   "else": null,
168   "enum": [],
169   "examples": [],
170   "exclusiveMaximum": null,
171   "exclusiveMinimum": null,
172   "format": "",
173   "if": null,
174   "items": null,
175   "maxContains": null,
176   "maxItems": null,
177   "maxLength": null,
178   "maxProperties": null,
179   "maximum": null,
180   "minContains": null,
181   "minItems": null,
182   "minLength": null,
183   "minProperties": null,
184   "minimum": null,
185   "multipleOf": null,
186   "not": null,
187   "oneOf": [],
188   "pattern": "",
189   "patternProperties": {},
190   "prefixItems": [],
191   "properties": {},
192   "propertyNames": null,
193   "readOnly": true,
194   "required": [
195     "host",
196     "port",
197     "database",
198     "username",
199     "password"
200   ],
201   "then": null,
202   "title": "PostgreSQL Connection Type Schema",
203   "type": "object",
204   "uniqueItems": false,
205   "writeOnly": false
206 }

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

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequired

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

Response

$anchorstringOptional

$commentstringOptional

$defsmap from strings to objectsOptional

$dynamicRefstringOptional

$idstringOptional

$refstringOptional

$schemastringOptional

additionalPropertiesobjectOptional

allOflist of objectsOptional

anyOflist of objectsOptional

constanyOptional

containsobjectOptional

contentEncodingstringOptional

contentMediaTypestringOptional

contentSchemaobjectOptional

defaultanyOptional

dependentRequiredmap from strings to lists of stringsOptional

dependentSchemasmap from strings to objectsOptional

deprecatedbooleanOptional

descriptionstringOptional

elseobjectOptional

enumlist of anyOptional

exampleslist of anyOptional

exclusiveMaximumstringOptional

exclusiveMinimumstringOptional

formatstringOptional

ifobjectOptional

itemsobjectOptional

maxContainsinteger or nullOptional>=0

maxItemsinteger or nullOptional>=0

maxLengthinteger or nullOptional>=0

maxPropertiesinteger or nullOptional>=0

maximumstringOptional

minContainsinteger or nullOptional>=0

minItemsinteger or nullOptional>=0

minLengthinteger or nullOptional>=0

minPropertiesinteger or nullOptional>=0

minimumstringOptional

multipleOfstringOptional

notobjectOptional

oneOflist of objectsOptional

patternstringOptional

patternPropertiesmap from strings to objectsOptional

prefixItemslist of objectsOptional

propertiesobjectOptional

propertyNamesobjectOptional

readOnlybooleanOptional

requiredlist of stringsOptional

thenobjectOptional

titlestringOptional

typestringOptional

uniqueItemsbooleanOptional

writeOnlybooleanOptional

Errors

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors