---
title: "Create OBProxy"
method: PUT
path: "/api/v1/obproxies"
tags: ["OBProxy"]
---

# Create OBProxy

`PUT /api/v1/obproxies`

Create OBProxy with the specified parameters

## Request body

- ObproxyCreateOBProxyParam
  - `image` string, required
  - `name` string, required
  - `namespace` string, required
  - `obCluster` ObproxyK8sObject, required
    - `name` string, required
    - `namespace` string, required
  - `parameters` CommonKVPair[]
    - `key` string, required
    - `value` string, required
  - `proxyClusterName` string, required
  - `proxySysPassword` string, required — Password should be encrypted
  - `replicas` integer, required
  - `resource` CommonResourceSpec, required
    - `cpu` integer, required
    - `memory` integer, required
  - `serviceType` 'ClusterIP' | 'NodePort' | 'LoadBalancer' | 'ExternalName', required

## Response `200`

OK

- object
  - `data` ObproxyOBProxy, required
    - `creationTime` integer, required
    - `image` string, required
    - `name` string, required
    - `namespace` string, required
    - `obCluster` ObproxyK8sObject, required
      - `name` string, required
      - `namespace` string, required
    - `parameters` CommonKVPair[], required
      - `key` string, required
      - `value` string, required
    - `pods` ResponseK8sPodInfo[], required
      - `containers` ResponseContainerInfo[], required
        - `image` string, required
        - `limits` CommonResourceSpec, required
          - `cpu` integer, required
          - `memory` integer, required
        - `name` string, required
        - `ports` integer[], required
        - `ready` boolean, required
        - `requests` CommonResourceSpec, required
          - `cpu` integer, required
          - `memory` integer, required
        - `restartCount` integer, required
        - `startTime` string, required
      - `message` string, required
      - `name` string, required
      - `namespace` string, required
      - `nodeName` string, required
      - `podIP` string, required
      - `reason` string, required
      - `startTime` string, required
      - `status` string, required
    - `proxyClusterName` string, required
    - `proxySysSecret` string, required
    - `replicas` integer, required
    - `resource` CommonResourceSpec, required
      - `cpu` integer, required
      - `memory` integer, required
    - `service` ResponseK8sService, required
      - `clusterIP` string, required
      - `externalIP` string
      - `name` string, required
      - `namespace` string, required
      - `ports` ResponseK8sServicePort[], required
        - `name` string
        - `nodePort` integer
        - `port` integer, required
        - `targetPort` integer, required
      - `type` string, 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/put.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)