Connections

Update Connection

PATCH

Path parameters

idstringRequired

Request

This endpoint expects an object.
configuration
map from strings to anyRequired
name
stringRequired
organization_id
stringOptional
policies
list of stringsOptional
reconnect
booleanOptional
type
stringOptional
validate
booleanOptional
Validate connection configuration.

Response

This endpoint returns an object
data
objectOptional
PATCH
1curl -X PATCH https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "configuration": {
6 "database": "example",
7 "hostname": "postgres.example.com",
8 "password": "password",
9 "port": 5432,
10 "username": "user"
11 },
12 "name": "My Postgres Connection"
13}'
200Updated
1{
2 "data": {
3 "auth_code": "auth_code",
4 "auth_url": "auth_url",
5 "configuration": {
6 "database": "example",
7 "hostname": "postgres.example.com",
8 "password": "password",
9 "port": 5432,
10 "username": "user"
11 },
12 "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
13 "name": "My Postgres Connection",
14 "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
15 "policies": [
16 "248df4b7-aa70-47b8-a036-33ac447e668d"
17 ],
18 "status": "healthy",
19 "status_error": "error message",
20 "type": {
21 "id": "postgresql",
22 "name": "PostgreSQL",
23 "operations": [
24 "operations"
25 ]
26 }
27 }
28}