--- title: "Returns MeshGlobalRateLimit entity" method: GET path: "/v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshglobalratelimits/{name}" tags: ["MeshGlobalRateLimit"] --- # Returns MeshGlobalRateLimit entity `GET /v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshglobalratelimits/{name}` ## Request - Base URL: `https://global.api.konghq.com` - URL: `https://global.api.konghq.com/v1/mesh/control-planes/{cpId}/api/meshes/{mesh}/meshglobalratelimits/{name}` - Auth: one of: - HTTP bearer - HTTP bearer - HTTP bearer - HTTP bearer ## Path parameters - `mesh` string, required - `name` string, required ## Response `200` Successful response - MeshGlobalRateLimitItem: MeshGlobalRateLimit - `type` 'MeshGlobalRateLimit', 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 MeshGlobalRateLimit resource. - `from` object[]: From list makes a match between clients and corresponding configurations - `default` object: Default is a configuration specific to the group of clients referenced in 'targetRef' - `backend` object, required: Backend defines location of rate limit backend service. - `rateLimitService` object, required - `limitOnServiceFail` boolean: LimitOnServiceFail will pass limit requests if ratelimit service is not reachable. - `timeout` string: Timeout for rate limit request made form Data Plane Proxy to rate limit service. - `url` string: Url defines address of rate limit service. - `http` object, required - `disabled` boolean: Define if rate limiting should be disabled. - `onRateLimit` object: Describes the actions to take on a rate limit event - `headers` object: The Headers to be added to the HTTP response on a rate limit event - … - `status` integer: The HTTP status code to be set on a rate limit event - `ratelimitOnRequest` object[]: Defines rate limit based on request content - `kind` 'OnHeader', required: Kind defines type of rate limit config. Possible options: OnHeader. - `limits` object[], required: Limits defines limit configuration. - … - `name` string, required: Name of the request element on which rate limit should apply. E.g. header name. - `requestRate` object: Defines how many requests are allowed per interval. - `interval` string, required: The interval the number of units is accounted for. Only 1s, 1m, 1h or 24h can be configured. - `num` integer, required: Number of units per interval (depending on usage it can be a number of requests, or a number of connections). - `mode` 'Limit' | 'Shadow': Mode defines rate limit behavior when limits are reached. Possible options: Limit and Shadow. Setting Shadow will not block over the limit requests but will update metrics. This is useful for testing rate limit configuration. - `targetRef` object, required: TargetRef is a reference to the resource that represents a group of clients. - `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` - `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` - `to` object[]: To list makes a match between clients and corresponding configurations - `default` object: Default is a configuration specific to the group of clients referenced in 'targetRef' - `backend` object, required: Backend defines location of rate limit backend service. - `rateLimitService` object, required - `limitOnServiceFail` boolean: LimitOnServiceFail will pass limit requests if ratelimit service is not reachable. - `timeout` string: Timeout for rate limit request made form Data Plane Proxy to rate limit service. - `url` string: Url defines address of rate limit service. - `http` object, required - `disabled` boolean: Define if rate limiting should be disabled. - `onRateLimit` object: Describes the actions to take on a rate limit event - `headers` object: The Headers to be added to the HTTP response on a rate limit event - … - `status` integer: The HTTP status code to be set on a rate limit event - `ratelimitOnRequest` object[]: Defines rate limit based on request content - `kind` 'OnHeader', required: Kind defines type of rate limit config. Possible options: OnHeader. - `limits` object[], required: Limits defines limit configuration. - … - `name` string, required: Name of the request element on which rate limit should apply. E.g. header name. - `requestRate` object: Defines how many requests are allowed per interval. - `interval` string, required: The interval the number of units is accounted for. Only 1s, 1m, 1h or 24h can be configured. - `num` integer, required: Number of units per interval (depending on usage it can be a number of requests, or a number of connections). - `mode` 'Limit' | 'Shadow': Mode defines rate limit behavior when limits are reached. Possible options: Limit and Shadow. Setting Shadow will not block over the limit requests but will update metrics. This is useful for testing rate limit configuration. - `targetRef` object, required: TargetRef is a reference to the resource that represents a group of clients. - `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 ## Changes - **2025-11-06** `5d2b35832e3f`: 1 info - added the optional property `kri` to the response with the `200` status - **2025-08-12** `b2800570b3e2`: 1 info - endpoint added [Operation history](https://skmtc.dev/kong/apis/konnect-api-beta/changes/v1/mesh/control-planes/:cpId/api/meshes/:mesh/meshglobalratelimits/:name/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)