---
title: "Connect to oceanbase database"
method: GET
path: "/api/v1/conn/{terminalId}"
tags: ["Terminal"]
---

# Connect to oceanbase database

`GET /api/v1/conn/{terminalId}`

Connect to oceanbase database in websocket

## Path parameters

- `terminalId` string, required

## Response `200`

OK

- object
  - `data` ResponseOBConnection, required
    - `clientIp` string
    - `cluster` string
    - `namespace` string
    - `odcConnectionURL` string
    - `pod` string
    - `tenant` string
    - `terminalId` string
    - `user` string
  - `message` string, required
  - `successful` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2024-04-09** `6cbf11f8c1ca` — 1 info
  - endpoint added
- **2024-02-27** `643ae3c8d824` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/conn/:terminalId/get.md)

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/fa579fa6f72d/schema)