Get the List

Developing

GET

connections

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'connections?page&limit&connectionType=&search&enableStatus&connectionPlatform' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "message": "Connections retrieved successfully",
    "connections": [
        {
            "id": "f13f1d10-69f1-4ae8-b834-4180ee09fb60",
            "name": "Hive Tes5",
            "description": null,
            "connectionType": "PUBLIC",
            "connectionPlatform": "HIVE",
            "payload": {
                "auth": "NONE",
                "host": "hive-server-hostname",
                "path": "/user/hive/warehouse",
                "port": 10000,
                "type": "hive",
                "database": "default",
                "password": "hive_password",
                "username": "hive_user"
            },
            "status": "ACTIVE",
            "is_enabled": "ENABLED",
            "createdAt": "2026-03-03T06:48:47.943Z",
            "updatedAt": "2026-03-03T06:48:47.943Z",
            "createdBy": {
                "id": "00000000-0000-0000-0000-000000000001",
                "email": "admin@spark.local",
                "name": "Default Admin"
            },
            "members": [
                {
                    "userId": "00000000-0000-0000-0000-000000000001",
                    "role": "OWNER",
                    "user": {
                        "id": "00000000-0000-0000-0000-000000000001",
                        "email": "admin@spark.local",
                        "name": "Default Admin"
                    }
                }
            ]
        },
        {
            "id": "c9aa9f0f-6a92-46ad-8b8d-2e085ee15306",
            "name": "Hive Tes2",
            "description": null,
            "connectionType": "PUBLIC",
            "connectionPlatform": "HIVE",
            "payload": {
                "auth": "NONE",
                "host": "hive-server-hostname",
                "path": "/user/hive/warehouse",
                "port": 10000,
                "type": "hive",
                "database": "default",
                "password": "hive_password",
                "username": "hive_user"
            },
            "status": "ACTIVE",
            "is_enabled": "DISABLED",
            "createdAt": "2026-03-02T21:04:04.850Z",
            "updatedAt": "2026-03-02T22:03:31.709Z",
            "createdBy": {
                "id": "00000000-0000-0000-0000-000000000001",
                "email": "admin@spark.local",
                "name": "Default Admin"
            },
            "members": [
                {
                    "userId": "00000000-0000-0000-0000-000000000001",
                    "role": "OWNER",
                    "user": {
                        "id": "00000000-0000-0000-0000-000000000001",
                        "email": "admin@spark.local",
                        "name": "Default Admin"
                    }
                }
            ]
        },
        {
            "id": "f7a65548-325b-4f25-997c-b69d082492d8",
            "name": "Hive Tes6",
            "description": null,
            "connectionType": "PRIVATE",
            "connectionPlatform": "HIVE",
            "payload": {
                "auth": "NONE",
                "host": "hive-server-hostname",
                "path": "/user/hive/warehouse",
                "port": 10000,
                "type": "hive",
                "database": "default",
                "password": "hive_password",
                "username": "hive_user"
            },
            "status": "ACTIVE",
            "is_enabled": "ENABLED",
            "createdAt": "2026-03-02T21:23:04.150Z",
            "updatedAt": "2026-03-02T21:31:53.414Z",
            "createdBy": {
                "id": "00000000-0000-0000-0000-000000000001",
                "email": "admin@spark.local",
                "name": "Default Admin"
            },
            "members": [
                {
                    "userId": "00000000-0000-0000-0000-000000000001",
                    "role": "OWNER",
                    "user": {
                        "id": "00000000-0000-0000-0000-000000000001",
                        "email": "admin@spark.local",
                        "name": "Default Admin"
                    }
                }
            ]
        },
        {
            "id": "1b802ef6-e052-487f-88c0-b23357df2506",
            "name": "Hive Test",
            "description": null,
            "connectionType": "PUBLIC",
            "connectionPlatform": "HIVE",
            "payload": {
                "auth": "NONE",
                "host": "hive-server-hostname",
                "path": "/user/hive/warehouse",
                "port": 10000,
                "type": "hive",
                "database": "default",
                "password": "hive_password",
                "username": "hive_user"
            },
            "status": "true",
            "is_enabled": "ENABLED",
            "createdAt": "2026-03-02T19:55:46.816Z",
            "updatedAt": "2026-03-02T19:55:46.816Z",
            "createdBy": {
                "id": "00000000-0000-0000-0000-000000000001",
                "email": "admin@spark.local",
                "name": "Default Admin"
            },
            "members": [
                {
                    "userId": "00000000-0000-0000-0000-000000000001",
                    "role": "OWNER",
                    "user": {
                        "id": "00000000-0000-0000-0000-000000000001",
                        "email": "admin@spark.local",
                        "name": "Default Admin"
                    }
                }
            ]
        }
    ],
    "pagination": {
        "page": 1,
        "totalPages": 1,
        "totalDocs": 4,
        "limit": 10
    }
}

Modified at 2026-03-09 10:30:20

Update Connection

Get Connection By Id