--- title: "Returns a list of Mesh in the mesh." method: GET path: "/v1/mesh/control-planes/{cpId}/api/meshes" tags: ["Mesh"] --- # Returns a list of Mesh in the mesh. `GET /v1/mesh/control-planes/{cpId}/api/meshes` ## Query parameters - `offset` integer - `size` integer - `filter` object - `key` string - `value` string ## Response `200` List - object - `items` MeshItem[] - `constraints` object — Constraints that applies to the mesh and its entities - `dataplaneProxy` object — DataplaneProxyMembership defines a set of requirements for data plane proxies to be a member of the mesh. - `requirements` object[] — Requirements defines a set of requirements that data plane proxies must fulfill in order to join the mesh. A data plane proxy must fulfill at least one requirement in order to join the mesh. Empty list of allowed requirements means that any proxy that is not explicitly denied can join. - `tags` object — Tags defines set of required tags. You can specify '*' in value to require non empty value of tag - `restrictions` object[] — Restrictions defines a set of restrictions that data plane proxies cannot fulfill in order to join the mesh. A data plane proxy cannot fulfill any requirement in order to join the mesh. Restrictions takes precedence over requirements. - `tags` object — Tags defines set of required tags. You can specify '*' in value to require non empty value of tag - `creationTime` string, date-time — Time at which the resource was created - `kri` string — Kuma Resource Identifier (KRI) of the given resource - `labels` object - `logging` object — Logging settings. +optional - `backends` object[] — List of available logging backends - `conf` union - object — FileLoggingBackendConfig defines configuration for file based access logs - `path` string — Path to a file that logs will be written to - object — TcpLoggingBackendConfig defines configuration for TCP based access logs - `address` string — Address to TCP service that will receive logs - `format` string — Format of access logs. Placeholders available on https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log - `name` string — Name of the backend, can be then used in Mesh.logging.defaultBackend or in TrafficLogging - `type` string — Type of the backend (Kuma ships with 'tcp' and 'file') - `defaultBackend` string — Name of the default backend - `meshServices` object - `mode` union - string - integer - `metrics` object — Configuration for metrics collected and exposed by dataplanes. Settings defined here become defaults for every dataplane in a given Mesh. Additionally, it is also possible to further customize this configuration for each dataplane individually using Dataplane resource. +optional - `backends` object[] — List of available Metrics backends - `conf` object — PrometheusMetricsBackendConfig defines configuration of Prometheus backend - `aggregate` object[] — Map with the configuration of applications which metrics are going to be scrapped by kuma-dp. - `address` string — Address on which a service expose HTTP endpoint with Prometheus metrics. - `enabled` boolean — If false then the application won't be scrapped. If nil, then it is treated as true and kuma-dp scrapes metrics from the service. - `name` string — Name which identify given configuration. - `path` string — Path on which a service expose HTTP endpoint with Prometheus metrics. - `port` integer — Port on which a service expose HTTP endpoint with Prometheus metrics. - `envoy` object — Configuration of Envoy's metrics. - `filterRegex` string — FilterRegex value that is going to be passed to Envoy for filtering Envoy metrics. - `usedOnly` boolean — If true then return metrics that Envoy has updated (counters incremented at least once, gauges changed at least once, and histograms added to at least once). If nil, then it is treated as false. - `path` string — Path on which a dataplane should expose HTTP endpoint with Prometheus metrics. - `port` integer — Port on which a dataplane should expose HTTP endpoint with Prometheus metrics. - `skipMTLS` boolean — If true then endpoints for scraping metrics won't require mTLS even if mTLS is enabled in Mesh. If nil, then it is treated as false. - `tags` object — Tags associated with an application this dataplane is deployed next to, e.g. service=web, version=1.0. `service` tag is mandatory. - `tls` object — Configuration of TLS for prometheus listener. - `mode` union — mode defines how configured is the TLS for Prometheus. Supported values, delegated, disabled, activeMTLSBackend. Default to `activeMTLSBackend`. - … - `name` string — Name of the backend, can be then used in Mesh.metrics.enabledBackend - `type` string — Type of the backend (Kuma ships with 'prometheus') - `enabledBackend` string — Name of the enabled backend - `modificationTime` string, date-time — Time at which the resource was updated - `mtls` object — mTLS settings. +optional - `backends` object[] — List of available Certificate Authority backends - `conf` union - object - `cert` union - … - `key` union - … - object - `caCert` object - … - object - `fromCp` object - … - object - `arn` string - `auth` object - … - `caCert` union - … - `commonName` string - object - `caCert` union - … - `commonName` string - `dnsNames` string[] - `issuerRef` object - … - `dpCert` object — Dataplane certificate settings - `requestTimeout` object — Timeout on request to CA for DP certificate generation and retrieval - `nanos` integer - `seconds` integer - `rotation` object — Rotation settings - `expiration` string — Time after which generated certificate for Dataplane will expire - `mode` union — Mode defines the behaviour of inbound listeners with regard to traffic encryption - string - integer - `name` string — Name of the backend - `rootChain` object - `requestTimeout` object — Timeout on request for to CA for root certificate chain. If not specified, defaults to 10s. - `nanos` integer - `seconds` integer - `type` string — Type of the backend. Has to be one of the loaded plugins (Kuma ships with builtin and provided) - `enabledBackend` string — Name of the enabled backend - `skipValidation` boolean — If enabled, skips CA validation. - `name` string, required - `networking` object — Networking settings of the mesh - `outbound` object — Outbound settings - `passthrough` boolean — Control the passthrough cluster - `routing` object — Routing settings of the mesh - `defaultForbidMeshExternalServiceAccess` boolean — If true, blocks traffic to MeshExternalServices. Default: false - `localityAwareLoadBalancing` boolean — Enable the Locality Aware Load Balancing - `zoneEgress` boolean — Enable routing traffic to services in other zone or external services through ZoneEgress. Default: false - `skipCreatingInitialPolicies` string[] — List of policies to skip creating by default when the mesh is created. e.g. TrafficPermission, MeshRetry, etc. An '*' can be used to skip all policies. - `tracing` object — Tracing settings. +optional - `backends` object[] — List of available tracing backends - `conf` union - object - `address` string — Address of datadog collector. - `port` integer — Port of datadog collector - `splitService` boolean — Determines if datadog service name should be split based on traffic direction and destination. For example, with `splitService: true` and a `backend` service that communicates with a couple of databases, you would get service names like `backend_INBOUND`, `backend_OUTBOUND_db1`, and `backend_OUTBOUND_db2` in Datadog. Default: false - object - `apiVersion` string — Version of the API. values: httpJson, httpJsonV1, httpProto. Default: httpJson see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/trace/v3/trace.proto#envoy-v3-api-enum-config-trace-v3-zipkinconfig-collectorendpointversion - `sharedSpanContext` boolean — Determines whether client and server spans will share the same span context. Default: true. https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/trace/v3/zipkin.proto#config-trace-v3-zipkinconfig - `traceId128bit` boolean — Generate 128bit traces. Default: false - `url` string — Address of Zipkin collector. - `name` string — Name of the backend, can be then used in Mesh.tracing.defaultBackend or in TrafficTrace - `sampling` number — Percentage of traces that will be sent to the backend (range 0.0 - 100.0). Empty value defaults to 100.0% - `type` string — Type of the backend (Kuma ships with 'zipkin') - `defaultBackend` string — Name of the default backend - `type` string, required - `next` string — URL to the next page - `total` number — The total number of entities --- [API](https://skmtc.net/kong/apis/konnect-api-beta.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-beta/revisions/658ffb748f95/schema)