---
title: "list obproxies"
method: GET
path: "/api/v1/obproxies"
tags: ["OBProxy"]
---

# list obproxies

`GET /api/v1/obproxies`

list obproxies

## Query parameters

- `ns` string

## Response `200`

OK

- object
  - `data` ObproxyOBProxyOverview[], required
    - `creationTime` integer, required
    - `image` string, required
    - `name` string, required
    - `namespace` string, required
    - `obCluster` ObproxyK8sObject, required
      - `name` string, required
      - `namespace` string, required
    - `proxyClusterName` string, required
    - `replicas` integer, required
    - `serviceIp` string, required
    - `serviceType` string, required
    - `status` 'Running' | 'Pending', required
  - `message` string, required
  - `successful` boolean, required

## Other responses

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

## Changes

- **2024-05-16** `1eec82c823a7` — 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/obproxies/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)