Updated on 2026-09-03 GMT+08:00

Modify Kibana/Dashboards Public Network Bandwidth

Function

If Kibana/Dashboards public network access is enabled for an Elasticsearch or OpenSearch cluster, you can use this API to modify the bandwidth for Kibana/Dashboards public network access.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidth

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints N/A Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition ID of the cluster whose public Kibana/Dashboards bandwidth you want to modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range UUID format, 36 characters. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
band_width	Yes	UpdatePublicKibanaBandwidthReqBandWidth object	Definition: Bandwidth information. Constraints: N/A.

**Table 3** UpdatePublicKibanaBandwidthReqBandWidth
Parameter	Mandatory	Type	Description
size	Yes	Integer	Definition: Bandwidth size after modification, in Mbit/s. Constraints: N/A Value range: 1–200 Default value: N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Modify the Kibana/Dashboards public network bandwidth.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/bandwidth

{
  "band_width" : {
    "size" : 5
  },
  "is_auto_pay" : 1
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.

Parent topic: Kibana/Dashboards Public Network Access