List Connections

GET

https://app.polytomic.com/api/connections

GET

/api/connections

1 from polytomic import Polytomic
2 
3 client = Polytomic(
4     version="YOUR_VERSION",
5     token="YOUR_TOKEN",
6 )
7 client.connections.list()

1 {
2   "data": [
3     {
4       "api_calls_last_24_hours": 2021,
5       "configuration": {
6         "database": "example",
7         "hostname": "postgres.example.com",
8         "password": "********",
9         "port": 5432,
10         "username": "user"
11       },
12       "created_at": "2024-01-15T09:30:00Z",
13       "created_by": {
14         "id": "12345678-1234-1234-1234-123456789012",
15         "name": "John Doe",
16         "type": "user"
17       },
18       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
19       "name": "My Postgres Connection",
20       "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
21       "parent_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
22       "policies": [
23         "248df4b7-aa70-47b8-a036-33ac447e668d"
24       ],
25       "saved": true,
26       "status": "healthy",
27       "status_error": "error message",
28       "type": {
29         "id": "postgresql",
30         "logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
31         "name": "PostgreSQL"
32       },
33       "updated_at": "2024-01-15T09:30:00Z",
34       "updated_by": {
35         "id": "12345678-1234-1234-1234-123456789012",
36         "name": "John Doe",
37         "type": "user"
38       }
39     }
40   ]
41 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

datalist of objects

Errors

401

Connections List Request Unauthorized Error

500

Connections List Request Internal Server Error

Authentication

Headers

Response

Errors