Get Connection | Polytomic Docs

curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "api_calls_last_24_hours": 2021,
    "configuration": {
      "database": "example",
      "hostname": "postgres.example.com",
      "password": "********",
      "port": 5432,
      "username": "user"
    },
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "name": "My Postgres Connection",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "parent_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "saved": true,
    "status": "healthy",
    "status_error": "error message",
    "type": {
      "id": "postgresql",
      "logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
      "name": "PostgreSQL",
      "operations": [
        "bulksyncsource"
      ]
    },
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    }
  }
}

Returns a single connection by ID, with sensitive fields redacted.

To inspect the schemas available on this connection, trigger a refresh with POST /api/connections/{id}/schemas/refresh and track progress via GET /api/connections/{id}/schemas/status.

Returns a single connection by ID, with sensitive fields redacted. To inspect the schemas available on this connection, trigger a refresh with [`POST /api/connections/{id}/schemas/refresh`](../../../api-reference/schemas/refresh) and track progress via [`GET /api/connections/{id}/schemas/status`](../../../api-reference/schemas/get-status).

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Response

dataobject

Errors

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors