Create Connection

POST

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

namestringRequired

typestringRequired

organization_idstringOptional

policieslist of stringsOptional

redirect_urlstringOptional

URL to redirect to after completing OAuth flow.

validatebooleanOptional

Validate connection configuration.

Response

This endpoint returns an object.

dataobjectOptional

Errors

POST

1 curl -X POST https://app.polytomic.com/api/connections \
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   "type": "postgresql"
14 }'

200Successful

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 }

Connect

Up Next

1	curl -X POST https://app.polytomic.com/api/connections \
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	"type": "postgresql"
14	}'

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	}