--- title: "Returns a list of MeshCircuitBreaker in the mesh." method: GET path: "/v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshcircuitbreakers" tags: ["MeshCircuitBreaker"] --- # Returns a list of MeshCircuitBreaker in the mesh. `GET /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshcircuitbreakers` ## Path parameters - `mesh` string, required ## Query parameters - `offset` integer - `size` integer - `filter` object - `key` string - `value` string ## Response `200` List - object - `items` MeshCircuitBreakerItem[] - `type` 'MeshCircuitBreaker', required — the type of the resource - `mesh` string — Mesh is the name of the Kuma mesh this resource belongs to. It may be omitted for cluster-scoped resources. - `kri` string — A unique identifier for this resource instance used by internal tooling and integrations. Typically derived from resource attributes and may be used for cross-references or indexing - `name` string, required — Name of the Kuma resource - `labels` object — The labels to help identity resources - `spec` object, required — Spec is the specification of the Kuma MeshCircuitBreaker resource. - `from` object[] — From list makes a match between clients and corresponding configurations - `default` object — Default is a configuration specific to the group of destinations referenced in 'targetRef' - `connectionLimits` object — ConnectionLimits contains configuration of each circuit breaking limit, which when exceeded makes the circuit breaker to become open (no traffic is allowed like no current is allowed in the circuits when physical circuit breaker ir open) - `maxConnectionPools` integer — The maximum number of connection pools per cluster that are concurrently supported at once. Set this for clusters which create a large number of connection pools. - `maxConnections` integer — The maximum number of connections allowed to be made to the upstream cluster. - `maxPendingRequests` integer — The maximum number of pending requests that are allowed to the upstream cluster. This limit is applied as a connection limit for non-HTTP traffic. - `maxRequests` integer — The maximum number of parallel requests that are allowed to be made to the upstream cluster. This limit does not apply to non-HTTP traffic. - `maxRetries` integer — The maximum number of parallel retries that will be allowed to the upstream cluster. - `outlierDetection` object — OutlierDetection contains the configuration of the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Performance might be along different axes such as consecutive failures, temporal success rate, temporal latency, etc. Outlier detection is a form of passive health checking. - `baseEjectionTime` string — The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. - `detectors` object — Contains configuration for supported outlier detectors - … - `disabled` boolean — When set to true, outlierDetection configuration won't take any effect - `healthyPanicThreshold` union — Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. - … - `interval` string — The time interval between ejection analysis sweeps. This can result in both new ejections and hosts being returned to service. - `maxEjectionPercent` integer — The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. - `splitExternalAndLocalErrors` boolean — Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: detectors.localOriginFailures.consecutive - `targetRef` object, required — TargetRef is a reference to the resource that represents a group of destinations. - `kind` 'Mesh' | 'MeshSubset' | 'MeshGateway' | 'MeshService' | 'MeshExternalService' | 'MeshMultiZoneService' | 'MeshServiceSubset' | 'MeshHTTPRoute' | 'Dataplane', required — Kind of the referenced resource - `labels` object — Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. - `mesh` string — Mesh is reserved for future use to identify cross mesh resources. - `name` string — Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` - `namespace` string — Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. - `proxyTypes` string[] — ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. - `sectionName` string — SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. - `tags` object — Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` - `rules` object[] — Rules defines inbound circuit breaker configurations. Currently limited to selecting all inbound traffic, as L7 matching is not yet implemented. - `default` object — Default contains configuration of the inbound circuit breaker - `connectionLimits` object — ConnectionLimits contains configuration of each circuit breaking limit, which when exceeded makes the circuit breaker to become open (no traffic is allowed like no current is allowed in the circuits when physical circuit breaker ir open) - `maxConnectionPools` integer — The maximum number of connection pools per cluster that are concurrently supported at once. Set this for clusters which create a large number of connection pools. - `maxConnections` integer — The maximum number of connections allowed to be made to the upstream cluster. - `maxPendingRequests` integer — The maximum number of pending requests that are allowed to the upstream cluster. This limit is applied as a connection limit for non-HTTP traffic. - `maxRequests` integer — The maximum number of parallel requests that are allowed to be made to the upstream cluster. This limit does not apply to non-HTTP traffic. - `maxRetries` integer — The maximum number of parallel retries that will be allowed to the upstream cluster. - `outlierDetection` object — OutlierDetection contains the configuration of the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Performance might be along different axes such as consecutive failures, temporal success rate, temporal latency, etc. Outlier detection is a form of passive health checking. - `baseEjectionTime` string — The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. - `detectors` object — Contains configuration for supported outlier detectors - … - `disabled` boolean — When set to true, outlierDetection configuration won't take any effect - `healthyPanicThreshold` union — Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. - … - `interval` string — The time interval between ejection analysis sweeps. This can result in both new ejections and hosts being returned to service. - `maxEjectionPercent` integer — The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. - `splitExternalAndLocalErrors` boolean — Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: detectors.localOriginFailures.consecutive - `targetRef` object — TargetRef is a reference to the resource the policy takes an effect on. The resource could be either a real store object or virtual resource defined in place. - `kind` 'Mesh' | 'MeshSubset' | 'MeshGateway' | 'MeshService' | 'MeshExternalService' | 'MeshMultiZoneService' | 'MeshServiceSubset' | 'MeshHTTPRoute' | 'Dataplane', required — Kind of the referenced resource - `labels` object — Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. - `mesh` string — Mesh is reserved for future use to identify cross mesh resources. - `name` string — Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` - `namespace` string — Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. - `proxyTypes` string[] — ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. - `sectionName` string — SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. - `tags` object — Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` - `to` object[] — To list makes a match between the consumed services and corresponding configurations - `default` object — Default is a configuration specific to the group of destinations referenced in 'targetRef' - `connectionLimits` object — ConnectionLimits contains configuration of each circuit breaking limit, which when exceeded makes the circuit breaker to become open (no traffic is allowed like no current is allowed in the circuits when physical circuit breaker ir open) - `maxConnectionPools` integer — The maximum number of connection pools per cluster that are concurrently supported at once. Set this for clusters which create a large number of connection pools. - `maxConnections` integer — The maximum number of connections allowed to be made to the upstream cluster. - `maxPendingRequests` integer — The maximum number of pending requests that are allowed to the upstream cluster. This limit is applied as a connection limit for non-HTTP traffic. - `maxRequests` integer — The maximum number of parallel requests that are allowed to be made to the upstream cluster. This limit does not apply to non-HTTP traffic. - `maxRetries` integer — The maximum number of parallel retries that will be allowed to the upstream cluster. - `outlierDetection` object — OutlierDetection contains the configuration of the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Performance might be along different axes such as consecutive failures, temporal success rate, temporal latency, etc. Outlier detection is a form of passive health checking. - `baseEjectionTime` string — The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. - `detectors` object — Contains configuration for supported outlier detectors - … - `disabled` boolean — When set to true, outlierDetection configuration won't take any effect - `healthyPanicThreshold` union — Allows to configure panic threshold for Envoy cluster. If not specified, the default is 50%. To disable panic mode, set to 0%. Either int or decimal represented as string. - … - `interval` string — The time interval between ejection analysis sweeps. This can result in both new ejections and hosts being returned to service. - `maxEjectionPercent` integer — The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. - `splitExternalAndLocalErrors` boolean — Determines whether to distinguish local origin failures from external errors. If set to true the following configuration parameters are taken into account: detectors.localOriginFailures.consecutive - `targetRef` object, required — TargetRef is a reference to the resource that represents a group of destinations. - `kind` 'Mesh' | 'MeshSubset' | 'MeshGateway' | 'MeshService' | 'MeshExternalService' | 'MeshMultiZoneService' | 'MeshServiceSubset' | 'MeshHTTPRoute' | 'Dataplane', required — Kind of the referenced resource - `labels` object — Labels are used to select group of MeshServices that match labels. Either Labels or Name and Namespace can be used. - `mesh` string — Mesh is reserved for future use to identify cross mesh resources. - `name` string — Name of the referenced resource. Can only be used with kinds: `MeshService`, `MeshServiceSubset` and `MeshGatewayRoute` - `namespace` string — Namespace specifies the namespace of target resource. If empty only resources in policy namespace will be targeted. - `proxyTypes` string[] — ProxyTypes specifies the data plane types that are subject to the policy. When not specified, all data plane types are targeted by the policy. - `sectionName` string — SectionName is used to target specific section of resource. For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected. - `tags` object — Tags used to select a subset of proxies by tags. Can only be used with kinds `MeshSubset` and `MeshServiceSubset` - `creationTime` string, date-time — Time at which the resource was created - `modificationTime` string, date-time — Time at which the resource was updated - `total` number — The total number of entities - `next` string — URL to the next page ## Changes - **2025-11-06** `5d2b35832e3f` — 1 info - added the optional property `items/items/kri` to the response with the `200` status [Change history](https://skmtc.dev/kong/apis/konnect-api-beta/changes/v1/mesh/control-planes/:cpId/api/meshes/:mesh/meshcircuitbreakers/get.md) --- [API](https://skmtc.dev/kong/apis/konnect-api-beta.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-beta/llms.txt) · [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-beta/revisions/cef0f947e9c9?raw)