Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
Logo
Log inBook a demo
API ReferenceConnections

GET
https://app.polytomic.com/api/connections/:id
GET
/api/connections/:id
1curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \
2 -H "Authorization: Bearer <token>"
Try it
1{
2 "data": {
3 "api_calls_last_24_hours": 2021,
4 "configuration": {
5 "database": "example",
6 "hostname": "postgres.example.com",
7 "password": "password",
8 "port": 5432,
9 "username": "user"
10 },
11 "created_at": "2024-01-15T09:30:00Z",
12 "created_by": {
13 "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14 "name": "name",
15 "type": "type"
16 },
17 "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
18 "name": "My Postgres Connection",
19 "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
20 "policies": [
21 "248df4b7-aa70-47b8-a036-33ac447e668d"
22 ],
23 "saved": true,
24 "status": "healthy",
25 "status_error": "error message",
26 "type": {
27 "id": "postgresql",
28 "name": "PostgreSQL",
29 "operations": [
30 "operations"
31 ]
32 },
33 "updated_at": "2024-01-15T09:30:00Z",
34 "updated_by": {
35 "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
36 "name": "name",
37 "type": "type"
38 }
39 }
40}
Was this page helpful?
Previous

Update Connection

Next
Built with
Get Connection

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject or null

Errors