Service

Update replica aware routing

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. <br /><br /> Updates replica aware routing (sticky routing) for the service. Requires the organization feature to be enabled. Provide at least one of httpEnabled, nativeEnabled; omit a field to leave it unchanged.

patch/v1/organizations/{organizationId}/services/{serviceId}/replicaAwareRouting

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/replicaAwareRouting
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service.

Request body

httpEnabledboolean

Whether replica aware routing is enabled for HTTP connections. Omit to leave unchanged.

nativeEnabledboolean

Whether replica aware routing is enabled for native protocol connections. Omit to leave unchanged.

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.