---
title: "Returns MeshProxyPatch entity"
method: GET
path: "/v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshproxypatches/{name}"
tags: ["MeshProxyPatch"]
---

# Returns MeshProxyPatch entity

`GET /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshproxypatches/{name}`

## Path parameters

- `mesh` string, required
- `name` string, required

## Response `200`

Successful response

- MeshProxyPatchItem — MeshProxyPatch provides advanced customization of the Envoy proxy configuration generated by Kuma. It allows you to add, remove, or modify Envoy resources (clusters, listeners, filters, virtual hosts) using YAML patches or JSON patches for fine-grained control beyond standard policies.
  - `type` 'MeshProxyPatch', 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 MeshProxyPatch resource.
    - `default` object, required — Default is a configuration specific to the group of destinations referenced in 'targetRef'.
      - `appendModifications` object[] — AppendModifications is a list of modifications applied on the selected proxy.
        - `cluster` object — Cluster is a modification of Envoy's Cluster resource.
          - `jsonPatches` object[] — JsonPatches specifies list of jsonpatches to apply to on Envoy's Cluster resource
            - `from` string — From is a jsonpatch from string, used by move and copy operations.
            - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy', required — Op is a jsonpatch operation string.
            - `path` string, required — Path is a jsonpatch path string.
            - `value` unknown
          - `match` object — Match is a set of conditions that have to be matched for modification operation to happen.
            - `name` string — Name of the cluster to match.
            - `origin` string — Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin.
          - `operation` 'Add' | 'Remove' | 'Patch', required — Operation to execute on matched cluster.
          - `value` string — Value of xDS resource in YAML format to add or patch.
        - `httpFilter` object — HTTPFilter is a modification of Envoy HTTP Filter available in HTTP Connection Manager in a Listener resource.
          - `jsonPatches` object[] — JsonPatches specifies list of jsonpatches to apply to on Envoy's HTTP Filter available in HTTP Connection Manager in a Listener resource.
            - `from` string — From is a jsonpatch from string, used by move and copy operations.
            - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy', required — Op is a jsonpatch operation string.
            - `path` string, required — Path is a jsonpatch path string.
            - `value` unknown
          - `match` object — Match is a set of conditions that have to be matched for modification operation to happen.
            - `listenerName` string — Name of the listener to match.
            - `listenerTags` object — Listener tags available in Listener#Metadata#FilterMetadata[io.kuma.tags]
            - `name` string — Name of the HTTP filter. For example "envoy.filters.http.local_ratelimit"
            - `origin` string — Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin.
          - `operation` 'Remove' | 'Patch' | 'AddFirst' | 'AddBefore' | 'AddAfter' | 'AddLast', required — Operation to execute on matched listener.
          - `value` string — Value of xDS resource in YAML format to add or patch.
        - `listener` object — Listener is a modification of Envoy's Listener resource.
          - `jsonPatches` object[] — JsonPatches specifies list of jsonpatches to apply to on Envoy's Listener resource
            - `from` string — From is a jsonpatch from string, used by move and copy operations.
            - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy', required — Op is a jsonpatch operation string.
            - `path` string, required — Path is a jsonpatch path string.
            - `value` unknown
          - `match` object — Match is a set of conditions that have to be matched for modification operation to happen.
            - `name` string — Name of the listener to match.
            - `origin` string — Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin.
            - `tags` object — Tags available in Listener#Metadata#FilterMetadata[io.kuma.tags]
          - `operation` 'Add' | 'Remove' | 'Patch', required — Operation to execute on matched listener.
          - `value` string — Value of xDS resource in YAML format to add or patch.
        - `networkFilter` object — NetworkFilter is a modification of Envoy Listener's filter.
          - `jsonPatches` object[] — JsonPatches specifies list of jsonpatches to apply to on Envoy Listener's filter.
            - `from` string — From is a jsonpatch from string, used by move and copy operations.
            - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy', required — Op is a jsonpatch operation string.
            - `path` string, required — Path is a jsonpatch path string.
            - `value` unknown
          - `match` object — Match is a set of conditions that have to be matched for modification operation to happen.
            - `listenerName` string — Name of the listener to match.
            - `listenerTags` object — Listener tags available in Listener#Metadata#FilterMetadata[io.kuma.tags]
            - `name` string — Name of the network filter. For example "envoy.filters.network.ratelimit"
            - `origin` string — Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin.
          - `operation` 'Remove' | 'Patch' | 'AddFirst' | 'AddBefore' | 'AddAfter' | 'AddLast', required — Operation to execute on matched listener.
          - `value` string — Value of xDS resource in YAML format to add or patch.
        - `virtualHost` object — VirtualHost is a modification of Envoy's VirtualHost referenced in HTTP Connection Manager in a Listener resource.
          - `jsonPatches` object[] — JsonPatches specifies list of jsonpatches to apply to on Envoy's VirtualHost resource
            - `from` string — From is a jsonpatch from string, used by move and copy operations.
            - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy', required — Op is a jsonpatch operation string.
            - `path` string, required — Path is a jsonpatch path string.
            - `value` unknown
          - `match` object, required — Match is a set of conditions that have to be matched for modification operation to happen.
            - `name` string — Name of the VirtualHost to match.
            - `origin` string — Origin is the name of the component or plugin that generated the resource. Here is the list of well-known origins: inbound - resources generated for handling incoming traffic. outbound - resources generated for handling outgoing traffic. transparent - resources generated for transparent proxy functionality. prometheus - resources generated when Prometheus metrics are enabled. direct-access - resources generated for Direct Access functionality. ingress - resources generated for Zone Ingress. egress - resources generated for Zone Egress. gateway - resources generated for MeshGateway. The list is not complete, because policy plugins can introduce new resources. For example MeshTrace plugin can create Cluster with "mesh-trace" origin.
            - `routeConfigurationName` string — Name of the RouteConfiguration resource to match.
          - `operation` 'Add' | 'Remove' | 'Patch', required — Operation to execute on matched listener.
          - `value` string — Value of xDS resource in YAML format to add or patch.
    - `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 inplace.
      - `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

## Other responses

- `404` — Not Found

---

[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)