GuidesAPI Reference
Guides

How to find rate limit rules

The HERE platform lets you fetch the rate limit rules for certain identity types and endpoints. This provides visibility on actively enforced rate limit rules and enhances transparency on enforced rate limits.

Rate limit rules can be configured to match various types of actors, such as customer tiers, realms, app IDs, authentication states, URL paths, and more.

Based on the rate limit defined within the enforced rule, any request that exceeds the defined limit fails with a 429 status code.

Identity types

Rate limit rules are applied based on the identities of a user (which might be an app, organization, or user account) and the rule's designated identity scope.

Identity ScopeDescription
meIncludes identity-specific and global rules (which are rules that apply to all identities within an organization)
defaultIncludes the rules for any generic identity from the calling identity's Organization, along with any global rules.
identityHrnIncludes all rules that match the specific identity (app/user) provided by the customer.

Rate limit rule APIs

Through the IAM Rate Limit APIs, you can access and manage rate limit rules for API endpoints on the platform.

If service-specific rules and endpoints exist, rate limits can be fetched per endpointId, pathPrefix, or URL.

For more information, see the Identity and Access Management Rate Limit Rules API v1 API Reference.

Rate limit endpoint APIs

You can use the Rate Limit Endpoint API to identify information about endpoints affected by rate limit rules on the platform. For more information, see Rate Limit Endpoints.

Note that endpoint details can be only part of the rule if already created and associated with the service.

How to fetch rate limit rules using CLI

The HERE platform also allows users to fetch the ratelimit rules using the CLI.

  • List of all rate limit rules that are active for identities in the organization.
  • Show details about a single rate limit rule for specific identity type and endpointId.

For more information, see the CLI documentation.