Get Connection

GET

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

GET

/api/connections/:id

1 import { PolytomicClient } from "polytomic";
2 
3 const client = new PolytomicClient({ token: "YOUR_TOKEN", version: "YOUR_VERSION" });
4 await client.connections.get("248df4b7-aa70-47b8-a036-33ac447e668d");

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

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

dataobject

Errors

401

Connections Get Request Unauthorized Error

404

Connections Get Request Not Found Error

500

Connections Get Request Internal Server Error

Authentication

Path parameters

Headers

Response

Errors